REST Resource: projects.locations
Stay organized with collections
Save and categorize content based on your preferences.
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 |
|
|
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-06-20 UTC.
[null,null,["Last updated 2025-06-20 UTC."],[],[],null,["# REST Resource: projects.locations\n\nResource: Location\n------------------\n\nA resource that represents a Google Cloud location.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"locationId\": string, \"displayName\": string, \"labels\": { string: string, ... }, \"metadata\": { \"@type\": string, field1: ..., ... } } ``` |\n\n| Fields ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"` |\n| `locationId` | `string` The canonical id for this location. For example: `\"us-east1\"`. |\n| `displayName` | `string` The friendly name for this location, typically a nearby city name. For example, \"Tokyo\". |\n| `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\" }`. |\n| `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\" }`. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------|-------------------------------------------------------------------|\n| ### [get](/docs/firestore/reference/rest/v1/projects.locations/get) | Gets information about a location. |\n| ### [list](/docs/firestore/reference/rest/v1/projects.locations/list) | Lists information about the supported locations for this service. |"]]
