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

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 address.

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

Returns a new instance of UserAddress.


3388
3389
3390
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3388

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

Instance Attribute Details

#countryString

Country. Corresponds to the JSON property country

Returns:

  • (String)

3319
3320
3321
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3319

def country
  @country
end

#country_codeString

Country code. Corresponds to the JSON property countryCode

Returns:

  • (String)

3324
3325
3326
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3324

def country_code
  @country_code
end

#custom_typeString

Custom type. Corresponds to the JSON property customType

Returns:

  • (String)

3329
3330
3331
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3329

def custom_type
  @custom_type
end

#extended_addressString

Extended Address. Corresponds to the JSON property extendedAddress

Returns:

  • (String)

3334
3335
3336
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3334

def extended_address
  @extended_address
end

#formattedString

Formatted address. Corresponds to the JSON property formatted

Returns:

  • (String)

3339
3340
3341
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3339

def formatted
  @formatted
end

#localityString

Locality. Corresponds to the JSON property locality

Returns:

  • (String)

3344
3345
3346
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3344

def locality
  @locality
end

#po_boxString

Other parts of address. Corresponds to the JSON property poBox

Returns:

  • (String)

3349
3350
3351
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3349

def po_box
  @po_box
end

#postal_codeString

Postal code. Corresponds to the JSON property postalCode

Returns:

  • (String)

3354
3355
3356
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3354

def postal_code
  @postal_code
end

#primaryBoolean 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)

3359
3360
3361
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3359

def primary
  @primary
end

#regionString

Region. Corresponds to the JSON property region

Returns:

  • (String)

3365
3366
3367
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3365

def region
  @region
end

#source_is_structuredBoolean 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)

3372
3373
3374
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3372

def source_is_structured
  @source_is_structured
end

#street_addressString

Street. Corresponds to the JSON property streetAddress

Returns:

  • (String)

3378
3379
3380
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3378

def street_address
  @street_address
end

#typeString

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)

3386
3387
3388
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3386

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3393

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