Class: Google::Apis::AdminDirectoryV1::UserLocation

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 a location entry.

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

Returns a new instance of UserLocation.



3688
3689
3690
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3688

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

Instance Attribute Details

#areaString

Textual location. This is most useful for display purposes to concisely describe the location. For example, "Mountain View, CA", "Near Seattle", "US- NYC-9TH 9A209A". Corresponds to the JSON property area

Returns:

  • (String)


3651
3652
3653
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3651

def area
  @area
end

#building_idString

Building Identifier. Corresponds to the JSON property buildingId

Returns:

  • (String)


3656
3657
3658
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3656

def building_id
  @building_id
end

#custom_typeString

Custom Type. Corresponds to the JSON property customType

Returns:

  • (String)


3661
3662
3663
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3661

def custom_type
  @custom_type
end

#desk_codeString

Most specific textual code of individual desk location. Corresponds to the JSON property deskCode

Returns:

  • (String)


3666
3667
3668
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3666

def desk_code
  @desk_code
end

#floor_nameString

Floor name/number. Corresponds to the JSON property floorName

Returns:

  • (String)


3671
3672
3673
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3671

def floor_name
  @floor_name
end

#floor_sectionString

Floor section. More specific location within the floor. For example, if a floor is divided into sections "A", "B", and "C", this field would identify one of those values. Corresponds to the JSON property floorSection

Returns:

  • (String)


3678
3679
3680
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3678

def floor_section
  @floor_section
end

#typeString

Each entry can have a type which indicates standard types of that entry. For example location could be of types default and desk. In addition to standard type, an entry can have a custom type and can give it any name. Such types should have "custom" as type and also have a customType value. Corresponds to the JSON property type

Returns:

  • (String)


3686
3687
3688
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3686

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3693
3694
3695
3696
3697
3698
3699
3700
3701
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 3693

def update!(**args)
  @area = args[:area] if args.key?(:area)
  @building_id = args[:building_id] if args.key?(:building_id)
  @custom_type = args[:custom_type] if args.key?(:custom_type)
  @desk_code = args[:desk_code] if args.key?(:desk_code)
  @floor_name = args[:floor_name] if args.key?(:floor_name)
  @floor_section = args[:floor_section] if args.key?(:floor_section)
  @type = args[:type] if args.key?(:type)
end