Class: Google::Apis::AdminDirectoryV1::UserAddress

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/admin_directory_v1/classes.rb,
lib/google/apis/admin_directory_v1/representations.rb,
lib/google/apis/admin_directory_v1/representations.rb

Overview

JSON template for address.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UserAddress

Returns a new instance of UserAddress.



4842
4843
4844
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4842

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#country ⇒ String

Country. Corresponds to the JSON property country

Returns:

  • (String) 


4773
4774
4775
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4773

def country
  @country
end

#country_code ⇒ String

Country code. Corresponds to the JSON property countryCode

Returns:

  • (String) 


4778
4779
4780
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4778

def country_code
  @country_code
end

#custom_type ⇒ String

Custom type. Corresponds to the JSON property customType

Returns:

  • (String) 


4783
4784
4785
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4783

def custom_type
  @custom_type
end

#extended_address ⇒ String

Extended Address. Corresponds to the JSON property extendedAddress

Returns:

  • (String) 


4788
4789
4790
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4788

def extended_address
  @extended_address
end

#formatted ⇒ String

Formatted address. Corresponds to the JSON property formatted

Returns:

  • (String) 


4793
4794
4795
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4793

def formatted
  @formatted
end

#locality ⇒ String

Locality. Corresponds to the JSON property locality

Returns:

  • (String) 


4798
4799
4800
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4798

def locality
  @locality
end

#po_box ⇒ String

Other parts of address. Corresponds to the JSON property poBox

Returns:

  • (String) 


4803
4804
4805
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4803

def po_box
  @po_box
end

#postal_code ⇒ String

Postal code. Corresponds to the JSON property postalCode

Returns:

  • (String) 


4808
4809
4810
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4808

def postal_code
  @postal_code
end

#primary ⇒ Boolean Also known as: primary?

If this is user's primary address. Only one entry could be marked as primary. Corresponds to the JSON property primary

Returns:

  • (Boolean) 


4813
4814
4815
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4813

def primary
  @primary
end

#region ⇒ String

Region. Corresponds to the JSON property region

Returns:

  • (String) 


4819
4820
4821
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4819

def region
  @region
end

#source_is_structured ⇒ Boolean Also known as: source_is_structured?

User supplied address was structured. Structured addresses are NOT supported at this time. You might be able to write structured addresses but any values will eventually be clobbered. Corresponds to the JSON property sourceIsStructured

Returns:

  • (Boolean) 


4826
4827
4828
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4826

def source_is_structured
  @source_is_structured
end

#street_address ⇒ String

Street. Corresponds to the JSON property streetAddress

Returns:

  • (String) 


4832
4833
4834
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4832

def street_address
  @street_address
end

#type ⇒ String

Each entry can have a type which indicates standard values of that entry. For example address could be of home work etc. In addition to the standard type an entry can have a custom type and can take any value. Such type should have the CUSTOM value as type and also have a customType value. Corresponds to the JSON property type

Returns:

  • (String) 


4840
4841
4842
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4840

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4847

def update!(**args)
  @country = args[:country] if args.key?(:country)
  @country_code = args[:country_code] if args.key?(:country_code)
  @custom_type = args[:custom_type] if args.key?(:custom_type)
  @extended_address = args[:extended_address] if args.key?(:extended_address)
  @formatted = args[:formatted] if args.key?(:formatted)
  @locality = args[:locality] if args.key?(:locality)
  @po_box = args[:po_box] if args.key?(:po_box)
  @postal_code = args[:postal_code] if args.key?(:postal_code)
  @primary = args[:primary] if args.key?(:primary)
  @region = args[:region] if args.key?(:region)
  @source_is_structured = args[:source_is_structured] if args.key?(:source_is_structured)
  @street_address = args[:street_address] if args.key?(:street_address)
  @type = args[:type] if args.key?(:type)
end