Class: Google::Apis::FirestoreV1::Location

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

A resource that represents a Google Cloud location.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Location

Returns a new instance of Location.



3036
3037
3038
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3036

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

Instance Attribute Details

#display_name ⇒ String

The friendly name for this location, typically a nearby city name. For example, "Tokyo". Corresponds to the JSON property displayName

Returns:

  • (String) 


3011
3012
3013
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3011

def display_name
  @display_name
end

#labels ⇒ Hash<String,String>

Cross-service attributes for the location. For example "cloud.googleapis.com/ region": "us-east1" Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


3017
3018
3019
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3017

def labels
  @labels
end

#location_id ⇒ String

The canonical id for this location. For example: "us-east1". Corresponds to the JSON property locationId

Returns:

  • (String) 


3022
3023
3024
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3022

def location_id
  @location_id
end

#metadata ⇒ Hash<String,Object>

Service-specific metadata. For example the available capacity at the given location. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,Object>) 


3028
3029
3030
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3028

def metadata
  @metadata
end

#name ⇒ String

Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1" Corresponds to the JSON property name

Returns:

  • (String) 


3034
3035
3036
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3034

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3041
3042
3043
3044
3045
3046
3047
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3041

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @labels = args[:labels] if args.key?(:labels)
  @location_id = args[:location_id] if args.key?(:location_id)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
end