Send feedback
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 .
IAM Permissions
Requires the following IAM permission on the name
resource:
blockchainnodeengine.locations.get
For more information, see the IAM documentation .
ListLocations
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
For more information, see the Authentication Overview .
IAM Permissions
Requires the following IAM permission on the name
resource:
blockchainnodeengine.locations.list
For more information, see the IAM documentation .
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.
Send feedback
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 2023-05-16 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2023-05-16 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 2023-05-16 UTC."]]