REST Resource: folders.locations
Resource: Location
A resource that represents a Google Cloud 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 |
|
CheckOnboardingStatus reports the onboarding status for a project/folder/organization. |
|
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-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-21 UTC."],[[["\u003cp\u003eThis document outlines the structure and details of a "Location" resource within Google Cloud, representing a specific geographic deployment area.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of a Location includes fields like \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 Location resource supports methods such as \u003ccode\u003echeckOnboardingStatus\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, and \u003ccode\u003elist\u003c/code\u003e, enabling users to retrieve location details and monitor onboarding states.\u003c/p\u003e\n"],["\u003cp\u003eThe resource allows you to access information like the canonical ID, friendly name, service attributes, and specific metadata regarding the location.\u003c/p\u003e\n"]]],[],null,[]]