Reference documentation and code samples for the Locations API class Google::Cloud::Location::Location.
A resource that represents Google Cloud Platform location.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#display_name
def display_name() -> ::String
Returns
- (::String) — The friendly name for this location, typically a nearby city name. For example, "Tokyo".
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — The friendly name for this location, typically a nearby city name. For example, "Tokyo".
Returns
- (::String) — The friendly name for this location, typically a nearby city name. For example, "Tokyo".
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
-
(::Google::Protobuf::Map{::String => ::String}) —
Cross-service attributes for the location. For example
{"cloud.googleapis.com/region": "us-east1"}
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
-
value (::Google::Protobuf::Map{::String => ::String}) —
Cross-service attributes for the location. For example
{"cloud.googleapis.com/region": "us-east1"}
Returns
-
(::Google::Protobuf::Map{::String => ::String}) —
Cross-service attributes for the location. For example
{"cloud.googleapis.com/region": "us-east1"}
#location_id
def location_id() -> ::String
Returns
-
(::String) — The canonical id for this location. For example:
"us-east1"
.
#location_id=
def location_id=(value) -> ::String
Parameter
-
value (::String) — The canonical id for this location. For example:
"us-east1"
.
Returns
-
(::String) — The canonical id for this location. For example:
"us-east1"
.
#metadata
def metadata() -> ::Google::Protobuf::Any
Returns
- (::Google::Protobuf::Any) — Service-specific metadata. For example the available capacity at the given location.
#metadata=
def metadata=(value) -> ::Google::Protobuf::Any
Parameter
- value (::Google::Protobuf::Any) — Service-specific metadata. For example the available capacity at the given location.
Returns
- (::Google::Protobuf::Any) — Service-specific metadata. For example the available capacity at the given location.
#name
def name() -> ::String
Returns
-
(::String) — Resource name for the location, which may vary between implementations.
For example:
"projects/example-project/locations/us-east1"
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Resource name for the location, which may vary between implementations.
For example:
"projects/example-project/locations/us-east1"
Returns
-
(::String) — Resource name for the location, which may vary between implementations.
For example:
"projects/example-project/locations/us-east1"