Class: Google::Apis::AdminDirectoryV1::BuildingAddress

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

Overview

JSON template for the postal address of a building in Directory API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BuildingAddress

Returns a new instance of BuildingAddress.



360
361
362
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 360

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

Instance Attribute Details

#address_lines ⇒ Array<String>

Unstructured address lines describing the lower levels of an address. Corresponds to the JSON property addressLines

Returns:

  • (Array<String>) 


324
325
326
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 324

def address_lines
  @address_lines
end

#administrative_area ⇒ String

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. Corresponds to the JSON property administrativeArea

Returns:

  • (String) 


330
331
332
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 330

def administrative_area
  @administrative_area
end

#language_code ⇒ String

Optional. BCP-47 language code of the contents of this address (if known). Corresponds to the JSON property languageCode

Returns:

  • (String) 


335
336
337
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 335

def language_code
  @language_code
end

#locality ⇒ String

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines. Corresponds to the JSON property locality

Returns:

  • (String) 


343
344
345
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 343

def locality
  @locality
end

#postal_code ⇒ String

Optional. Postal code of the address. Corresponds to the JSON property postalCode

Returns:

  • (String) 


348
349
350
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 348

def postal_code
  @postal_code
end

#region_code ⇒ String

Required. CLDR region code of the country/region of the address. Corresponds to the JSON property regionCode

Returns:

  • (String) 


353
354
355
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 353

def region_code
  @region_code
end

#sublocality ⇒ String

Optional. Sublocality of the address. Corresponds to the JSON property sublocality

Returns:

  • (String) 


358
359
360
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 358

def sublocality
  @sublocality
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



365
366
367
368
369
370
371
372
373
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 365

def update!(**args)
  @address_lines = args[:address_lines] if args.key?(:address_lines)
  @administrative_area = args[:administrative_area] if args.key?(:administrative_area)
  @language_code = args[:language_code] if args.key?(:language_code)
  @locality = args[:locality] if args.key?(:locality)
  @postal_code = args[:postal_code] if args.key?(:postal_code)
  @region_code = args[:region_code] if args.key?(:region_code)
  @sublocality = args[:sublocality] if args.key?(:sublocality)
end