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



3540
3541
3542
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3540

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

Instance Attribute Details

#country ⇒ String

Country. Corresponds to the JSON property country

Returns:

  • (String) 


3471
3472
3473
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3471

def country
  @country
end

#country_code ⇒ String

Country code. Corresponds to the JSON property countryCode

Returns:

  • (String) 


3476
3477
3478
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3476

def country_code
  @country_code
end

#custom_type ⇒ String

Custom type. Corresponds to the JSON property customType

Returns:

  • (String) 


3481
3482
3483
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3481

def custom_type
  @custom_type
end

#extended_address ⇒ String

Extended Address. Corresponds to the JSON property extendedAddress

Returns:

  • (String) 


3486
3487
3488
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3486

def extended_address
  @extended_address
end

#formatted ⇒ String

Formatted address. Corresponds to the JSON property formatted

Returns:

  • (String) 


3491
3492
3493
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3491

def formatted
  @formatted
end

#locality ⇒ String

Locality. Corresponds to the JSON property locality

Returns:

  • (String) 


3496
3497
3498
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3496

def locality
  @locality
end

#po_box ⇒ String

Other parts of address. Corresponds to the JSON property poBox

Returns:

  • (String) 


3501
3502
3503
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3501

def po_box
  @po_box
end

#postal_code ⇒ String

Postal code. Corresponds to the JSON property postalCode

Returns:

  • (String) 


3506
3507
3508
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3506

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) 


3511
3512
3513
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3511

def primary
  @primary
end

#region ⇒ String

Region. Corresponds to the JSON property region

Returns:

  • (String) 


3517
3518
3519
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3517

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) 


3524
3525
3526
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3524

def source_is_structured
  @source_is_structured
end

#street_address ⇒ String

Street. Corresponds to the JSON property streetAddress

Returns:

  • (String) 


3530
3531
3532
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3530

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) 


3538
3539
3540
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3538

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3545

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