Class: Google::Apis::AdminDirectoryV1::UserAddress
- Inherits:
-
Object
- Object
- Google::Apis::AdminDirectoryV1::UserAddress
- 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
-
#country ⇒ String
Country.
-
#country_code ⇒ String
Country code.
-
#custom_type ⇒ String
Custom type.
-
#extended_address ⇒ String
Extended Address.
-
#formatted ⇒ String
Formatted address.
-
#locality ⇒ String
Locality.
-
#po_box ⇒ String
Other parts of address.
-
#postal_code ⇒ String
Postal code.
-
#primary ⇒ Boolean
(also: #primary?)
If this is user's primary address.
-
#region ⇒ String
Region.
-
#source_is_structured ⇒ Boolean
(also: #source_is_structured?)
User supplied address was structured.
-
#street_address ⇒ String
Street.
-
#type ⇒ String
Each entry can have a type which indicates standard values of that entry.
Instance Method Summary collapse
-
#initialize(**args) ⇒ UserAddress
constructor
A new instance of UserAddress.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ UserAddress
Returns a new instance of UserAddress.
4188 4189 4190 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4188 def initialize(**args) update!(**args) end |
Instance Attribute Details
#country ⇒ String
Country.
Corresponds to the JSON property country
4119 4120 4121 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4119 def country @country end |
#country_code ⇒ String
Country code.
Corresponds to the JSON property countryCode
4124 4125 4126 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4124 def country_code @country_code end |
#custom_type ⇒ String
Custom type.
Corresponds to the JSON property customType
4129 4130 4131 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4129 def custom_type @custom_type end |
#extended_address ⇒ String
Extended Address.
Corresponds to the JSON property extendedAddress
4134 4135 4136 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4134 def extended_address @extended_address end |
#formatted ⇒ String
Formatted address.
Corresponds to the JSON property formatted
4139 4140 4141 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4139 def formatted @formatted end |
#locality ⇒ String
Locality.
Corresponds to the JSON property locality
4144 4145 4146 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4144 def locality @locality end |
#po_box ⇒ String
Other parts of address.
Corresponds to the JSON property poBox
4149 4150 4151 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4149 def po_box @po_box end |
#postal_code ⇒ String
Postal code.
Corresponds to the JSON property postalCode
4154 4155 4156 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4154 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
4159 4160 4161 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4159 def primary @primary end |
#region ⇒ String
Region.
Corresponds to the JSON property region
4165 4166 4167 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4165 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
4172 4173 4174 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4172 def source_is_structured @source_is_structured end |
#street_address ⇒ String
Street.
Corresponds to the JSON property streetAddress
4178 4179 4180 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4178 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
4186 4187 4188 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4186 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4193 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 |