Package google.cloud.location
Stay organized with collections
Save and categorize content based on your preferences.
Locations
An abstract interface that provides location-related information for a service. Service-specific metadata is provided through the Location.metadata field.
| GetLocation |
|
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.
|
GetLocationRequest
| Fields |
name |
string
Resource name for the location.
|
ListLocationsRequest
| Fields |
name |
string
The resource that owns the locations collection, if applicable.
|
filter |
string
A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.
|
page_size |
int32
The maximum number of results to return. If not set, the service selects a default.
|
page_token |
string
A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
|
ListLocationsResponse
| Fields |
locations[] |
Location
A list of locations that matches the specified filter in the request.
|
next_page_token |
string
The standard List next-page token.
|
Location
A resource that represents a Google Cloud location.
| Fields |
name |
string
Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
|
location_id |
string
The canonical id for this location. For example: "us-east1".
|
display_name |
string
The friendly name for this location, typically a nearby city name. For example, "Tokyo".
|
labels |
map<string, string>
Cross-service attributes for the location. For example
{"cloud.googleapis.com/region": "us-east1"}
|
metadata |
Any
Service-specific metadata. For example the available capacity at the given location.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-21 UTC."],[[["\u003cp\u003eThis documentation describes the \u003ccode\u003eLocations\u003c/code\u003e interface, which provides location-related information for a service, including its specific metadata.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGetLocation\u003c/code\u003e RPC method retrieves information about a specific location and requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListLocations\u003c/code\u003e RPC method lists information about supported locations for the service and also requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eRequests to list locations can be refined using the \u003ccode\u003eListLocationsRequest\u003c/code\u003e message, which allows for filtering, setting page size, and using page tokens for pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eLocation\u003c/code\u003e message details the attributes of a given location, such as its name, ID, display name, labels, and service-specific metadata.\u003c/p\u003e\n"]]],[],null,["# Package google.cloud.location\n\nIndex\n-----\n\n- [Locations](/certificate-authority-service/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations) (interface)\n- [GetLocationRequest](/certificate-authority-service/docs/reference/rpc/google.cloud.location#google.cloud.location.GetLocationRequest) (message)\n- [ListLocationsRequest](/certificate-authority-service/docs/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsRequest) (message)\n- [ListLocationsResponse](/certificate-authority-service/docs/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsResponse) (message)\n- [Location](/certificate-authority-service/docs/reference/rpc/google.cloud.location#google.cloud.location.Location) (message)\n\nLocations\n---------\n\nAn abstract interface that provides location-related information for a service. Service-specific metadata is provided through the [Location.metadata](/certificate-authority-service/docs/reference/rpc/google.cloud.location#google.cloud.location.Location.FIELDS.google.protobuf.Any.google.cloud.location.Location.metadata) field.\n\nGetLocationRequest\n------------------\n\nThe request message for [Locations.GetLocation](/certificate-authority-service/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations.GetLocation).\n\nListLocationsRequest\n--------------------\n\nThe request message for [Locations.ListLocations](/certificate-authority-service/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations.ListLocations).\n\nListLocationsResponse\n---------------------\n\nThe response message for [Locations.ListLocations](/certificate-authority-service/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations.ListLocations).\n\nLocation\n--------\n\nA resource that represents a Google Cloud location."]]
