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



2668
2669
2670
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2668

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

Instance Attribute Details

#country ⇒ String

Country. Corresponds to the JSON property country

Returns:

  • (String) 


2599
2600
2601
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2599

def country
  @country
end

#country_code ⇒ String

Country code. Corresponds to the JSON property countryCode

Returns:

  • (String) 


2604
2605
2606
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2604

def country_code
  @country_code
end

#custom_type ⇒ String

Custom type. Corresponds to the JSON property customType

Returns:

  • (String) 


2609
2610
2611
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2609

def custom_type
  @custom_type
end

#extended_address ⇒ String

Extended Address. Corresponds to the JSON property extendedAddress

Returns:

  • (String) 


2614
2615
2616
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2614

def extended_address
  @extended_address
end

#formatted ⇒ String

Formatted address. Corresponds to the JSON property formatted

Returns:

  • (String) 


2619
2620
2621
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2619

def formatted
  @formatted
end

#locality ⇒ String

Locality. Corresponds to the JSON property locality

Returns:

  • (String) 


2624
2625
2626
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2624

def locality
  @locality
end

#po_box ⇒ String

Other parts of address. Corresponds to the JSON property poBox

Returns:

  • (String) 


2629
2630
2631
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2629

def po_box
  @po_box
end

#postal_code ⇒ String

Postal code. Corresponds to the JSON property postalCode

Returns:

  • (String) 


2634
2635
2636
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2634

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) 


2639
2640
2641
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2639

def primary
  @primary
end

#region ⇒ String

Region. Corresponds to the JSON property region

Returns:

  • (String) 


2645
2646
2647
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2645

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) 


2652
2653
2654
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2652

def source_is_structured
  @source_is_structured
end

#street_address ⇒ String

Street. Corresponds to the JSON property streetAddress

Returns:

  • (String) 


2658
2659
2660
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2658

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) 


2666
2667
2668
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2666

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2673

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