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.
rpc GetLocation(
GetLocationRequest
) returns ( Location
)
Gets information about a location.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
-
- IAM Permissions
-
Requires the following IAM permission on the
nameresource:-
apim.locations.get
For more information, see the IAM documentation .
-
rpc ListLocations(
ListLocationsRequest
) returns ( ListLocationsResponse
)
Lists information about the supported locations for this service.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
-
- IAM Permissions
-
Requires the following IAM permission on the
nameresource:-
apim.locations.list
For more information, see the IAM documentation .
-
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
|
A filter to narrow down results to a preferred subset. The filtering language accepts strings like |
page_size
|
The maximum number of results to return. If not set, the service selects a default. |
page_token
|
A page token received from the |
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 a Google Cloud 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. |
