# Package google.cloud.location

## Index

- `https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.Locations` (interface)
- `https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.GetLocationRequest` (message)
- `https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsRequest` (message)
- `https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsResponse` (message)
- `https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.Location` (message)

## Locations

An abstract interface that provides location-related information for a service. Service-specific metadata is provided through the `https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.Location.FIELDS.google.protobuf.Any.google.cloud.location.Location.metadata` field.

| GetLocation |
|---|
| `` rpc GetLocation(`https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.GetLocationRequest`) returns (`https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.Location`) `` Gets information about a location. Authorization Scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/appengine.admin` - ` https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/cloud-platform.read-only` For more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/). |

| ListLocations |
|---|
| `` rpc ListLocations(`https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsRequest`) returns (`https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsResponse`) `` Lists information about the supported locations for this service. Authorization Scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/appengine.admin` - ` https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/cloud-platform.read-only` For more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/). |

## GetLocationRequest

The request message for `https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.Locations.GetLocation`.

| Fields ||
|---|---|
| `name` | `string` Resource name for the location. |

## ListLocationsRequest

The request message for `https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.Locations.ListLocations`.

| 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](https://google.aip.dev/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

The response message for `https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.Locations.ListLocations`.

| Fields ||
|---|---|
| `locations[]` | `` `https://docs.cloud.google.com/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.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 Google Cloud Platform 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` | `` `https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any` `` Service-specific metadata. For example the available capacity at the given location. |