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



2863
2864
2865
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2863

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

Instance Attribute Details

#areaString

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

Returns:

  • (String)


2826
2827
2828
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2826

def area
  @area
end

#building_idString

Building Identifier. Corresponds to the JSON property buildingId

Returns:

  • (String)


2831
2832
2833
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2831

def building_id
  @building_id
end

#custom_typeString

Custom Type. Corresponds to the JSON property customType

Returns:

  • (String)


2836
2837
2838
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2836

def custom_type
  @custom_type
end

#desk_codeString

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

Returns:

  • (String)


2841
2842
2843
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2841

def desk_code
  @desk_code
end

#floor_nameString

Floor name/number. Corresponds to the JSON property floorName

Returns:

  • (String)


2846
2847
2848
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2846

def floor_name
  @floor_name
end

#floor_sectionString

Floor Section. More specific location within the floor. E.g. 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)


2853
2854
2855
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2853

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)


2861
2862
2863
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2861

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2868
2869
2870
2871
2872
2873
2874
2875
2876
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2868

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