Index
Locations
(interface)GetLocationRequest
(message)ListLocationsRequest
(message)ListLocationsResponse
(message)Location
(message)
Locations
An abstract interface that provides location-related information for a service. Service-specific metadata is provided through the Location.metadata
field.
GetLocation | |
---|---|
Gets information about a location.
|
ListLocations | |
---|---|
Lists information about the supported locations for this service.
|
GetLocationRequest
The request message for Locations.GetLocation
.
Fields | |
---|---|
name |
Resource name for the location. |
ListLocationsRequest
The request message for Locations.ListLocations
.
Fields | |
---|---|
name |
The resource that owns the locations collection, if applicable. |
filter |
The standard list filter. |
page_size |
The standard list page size. |
page_token |
The standard list page token. |
ListLocationsResponse
The response message for Locations.ListLocations
.
Fields | |
---|---|
locations[] |
A list of locations that matches the specified filter in the request. |
next_page_token |
The standard List next-page token. |
Location
A resource that represents Google Cloud Platform location.
Fields | |
---|---|
name |
Resource name for the location, which may vary between implementations. For example: |
location_id |
The canonical id for this location. For example: |
display_name |
The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
labels |
Cross-service attributes for the location. For example
|
metadata |
Service-specific metadata. For example the available capacity at the given location. |