REST Resource: projects.locations
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Location
A resource that represents Google Cloud Platform location.
JSON representation |
{
"name": string,
"locationId": string,
"displayName": string,
"labels": {
string: string,
...
},
"metadata": {
"@type": string,
field1: ...,
...
}
} |
Fields |
name |
string
Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
|
locationId |
string
The canonical id for this location. For example: "us-east1" .
|
displayName |
string
The friendly name for this location, typically a nearby city name. For example, "Tokyo".
|
labels |
map (key: string, value: string)
Cross-service attributes for the location. For example
{"cloud.googleapis.com/region": "us-east1"}
An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
|
metadata |
object
Service-specific metadata. For example the available capacity at the given location. An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
Methods |
|
Gets information about a location. |
|
Lists information about the supported locations for this service. |
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-05-30 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-05-30 UTC."],[[["\u003cp\u003eThis document details the "Location" resource within the Google Cloud Platform, which represents a specific geographic location.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of a Location includes fields such as \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003elocationId\u003c/code\u003e, \u003ccode\u003edisplayName\u003c/code\u003e, \u003ccode\u003elabels\u003c/code\u003e, and \u003ccode\u003emetadata\u003c/code\u003e, each serving to identify and describe the location.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e and \u003ccode\u003elocationId\u003c/code\u003e fields provide the resource name and canonical ID of the location, respectively, while \u003ccode\u003edisplayName\u003c/code\u003e provides a user-friendly name, such as a city.\u003c/p\u003e\n"],["\u003cp\u003eThe document outlines two primary methods for interacting with locations: \u003ccode\u003eget\u003c/code\u003e to retrieve information about a single location, and \u003ccode\u003elist\u003c/code\u003e to retrieve multiple locations.\u003c/p\u003e\n"]]],[],null,["# REST Resource: projects.locations\n\n- [Resource: Location](#Location)\n - [JSON representation](#Location.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Location\n------------------\n\nA resource that represents Google Cloud Platform location."]]