Class: Google::Apis::PeopleV1::Address

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

Overview

A person's physical address. May be a P.O. box or street address. All fields are optional.

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) ⇒ Address

Returns a new instance of Address



97
98
99
 
# File 'generated/google/apis/people_v1/classes.rb', line 97

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

Instance Attribute Details

#city ⇒ String

The city of the address. Corresponds to the JSON property city

Returns:

  • (String) 


33
34
35
 
# File 'generated/google/apis/people_v1/classes.rb', line 33

def city
  @city
end

#country ⇒ String

The country of the address. Corresponds to the JSON property country

Returns:

  • (String) 


38
39
40
 
# File 'generated/google/apis/people_v1/classes.rb', line 38

def country
  @country
end

#country_code ⇒ String

The ISO 3166-1 alpha-2 country code of the address. Corresponds to the JSON property countryCode

Returns:

  • (String) 


44
45
46
 
# File 'generated/google/apis/people_v1/classes.rb', line 44

def country_code
  @country_code
end

#extended_address ⇒ String

The extended address of the address; for example, the apartment number. Corresponds to the JSON property extendedAddress

Returns:

  • (String) 


49
50
51
 
# File 'generated/google/apis/people_v1/classes.rb', line 49

def extended_address
  @extended_address
end

#formatted_type ⇒ String

The read-only type of the address translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale. Corresponds to the JSON property formattedType

Returns:

  • (String) 


55
56
57
 
# File 'generated/google/apis/people_v1/classes.rb', line 55

def formatted_type
  @formatted_type
end

#formatted_value ⇒ String

The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values. Corresponds to the JSON property formattedValue

Returns:

  • (String) 


61
62
63
 
# File 'generated/google/apis/people_v1/classes.rb', line 61

def formatted_value
  @formatted_value
end

#metadata ⇒ Google::Apis::PeopleV1::FieldMetadata

Metadata about a field. Corresponds to the JSON property metadata

Returns:



66
67
68
 
# File 'generated/google/apis/people_v1/classes.rb', line 66

def metadata
  @metadata
end

#po_box ⇒ String

The P.O. box of the address. Corresponds to the JSON property poBox

Returns:

  • (String) 


71
72
73
 
# File 'generated/google/apis/people_v1/classes.rb', line 71

def po_box
  @po_box
end

#postal_code ⇒ String

The postal code of the address. Corresponds to the JSON property postalCode

Returns:

  • (String) 


76
77
78
 
# File 'generated/google/apis/people_v1/classes.rb', line 76

def postal_code
  @postal_code
end

#region ⇒ String

The region of the address; for example, the state or province. Corresponds to the JSON property region

Returns:

  • (String) 


81
82
83
 
# File 'generated/google/apis/people_v1/classes.rb', line 81

def region
  @region
end

#street_address ⇒ String

The street address. Corresponds to the JSON property streetAddress

Returns:

  • (String) 


86
87
88
 
# File 'generated/google/apis/people_v1/classes.rb', line 86

def street_address
  @street_address
end

#type ⇒ String

The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following:

  • home
  • work
  • other Corresponds to the JSON property type

Returns:

  • (String) 


95
96
97
 
# File 'generated/google/apis/people_v1/classes.rb', line 95

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'generated/google/apis/people_v1/classes.rb', line 102

def update!(**args)
  @city = args[:city] if args.key?(:city)
  @country = args[:country] if args.key?(:country)
  @country_code = args[:country_code] if args.key?(:country_code)
  @extended_address = args[:extended_address] if args.key?(:extended_address)
  @formatted_type = args[:formatted_type] if args.key?(:formatted_type)
  @formatted_value = args[:formatted_value] if args.key?(:formatted_value)
  @metadata = args[:metadata] if args.key?(:metadata)
  @po_box = args[:po_box] if args.key?(:po_box)
  @postal_code = args[:postal_code] if args.key?(:postal_code)
  @region = args[:region] if args.key?(:region)
  @street_address = args[:street_address] if args.key?(:street_address)
  @type = args[:type] if args.key?(:type)
end