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.



4184
4185
4186
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4184

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

Instance Attribute Details

#country ⇒ String

Country. Corresponds to the JSON property country

Returns:

  • (String) 


4115
4116
4117
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4115

def country
  @country
end

#country_code ⇒ String

Country code. Corresponds to the JSON property countryCode

Returns:

  • (String) 


4120
4121
4122
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4120

def country_code
  @country_code
end

#custom_type ⇒ String

Custom type. Corresponds to the JSON property customType

Returns:

  • (String) 


4125
4126
4127
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4125

def custom_type
  @custom_type
end

#extended_address ⇒ String

Extended Address. Corresponds to the JSON property extendedAddress

Returns:

  • (String) 


4130
4131
4132
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4130

def extended_address
  @extended_address
end

#formatted ⇒ String

Formatted address. Corresponds to the JSON property formatted

Returns:

  • (String) 


4135
4136
4137
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4135

def formatted
  @formatted
end

#locality ⇒ String

Locality. Corresponds to the JSON property locality

Returns:

  • (String) 


4140
4141
4142
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4140

def locality
  @locality
end

#po_box ⇒ String

Other parts of address. Corresponds to the JSON property poBox

Returns:

  • (String) 


4145
4146
4147
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4145

def po_box
  @po_box
end

#postal_code ⇒ String

Postal code. Corresponds to the JSON property postalCode

Returns:

  • (String) 


4150
4151
4152
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4150

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) 


4155
4156
4157
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4155

def primary
  @primary
end

#region ⇒ String

Region. Corresponds to the JSON property region

Returns:

  • (String) 


4161
4162
4163
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4161

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) 


4168
4169
4170
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4168

def source_is_structured
  @source_is_structured
end

#street_address ⇒ String

Street. Corresponds to the JSON property streetAddress

Returns:

  • (String) 


4174
4175
4176
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4174

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) 


4182
4183
4184
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4182

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4189

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