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
For more information, see the Authentication Overview .
-
- IAM Permissions
-
Requires the following IAM permission on the
nameresource:-
observability.locations.get
For more information, see the IAM documentation .
-
rpc ListLocations(
ListLocationsRequest
) returns ( ListLocationsResponse
)
Lists information about the supported locations for this service.
This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field:
- Global locations: If
nameis empty, the method lists the public locations available to all projects. - Project-specific locations: If
namefollows the formatprojects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.
For gRPC and client library implementations, the resource name is passed as the name
field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
- IAM Permissions
-
Requires the following IAM permission on the
nameresource:-
observability.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 |
extra_location_types[]
|
Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. |
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. |
