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

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

Overview

A resource that represents Google Cloud Platform location.

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

Returns a new instance of Location

[View source]

1768
1769
1770
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1768

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) 

1743
1744
1745
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1743

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

1749
1750
1751
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1749

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) 

1754
1755
1756
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1754

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

1760
1761
1762
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1760

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) 

1766
1767
1768
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1766

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

1773
1774
1775
1776
1777
1778
1779
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1773

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