package google.cloud.location

Get desktop application:
View/edit binary Protocol Buffers messages

An abstract interface that provides location-related information for a service. Service-specific metadata is provided through the [Location.metadata][google.cloud.location.Location.metadata] field.

• rpc ListLocations (ListLocationsRequest, ListLocationsResponse)

  locations.proto:33

  Lists information about the supported locations for this service.

  message ListLocationsRequest

  locations.proto:49

  The request message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].

  • string name = 1

    The resource that owns the locations collection, if applicable.

  • string filter = 2

    The standard list filter.

  • int32 page_size = 3

    The standard list page size.

  • string page_token = 4

    The standard list page token.

  message ListLocationsResponse

  locations.proto:65

  The response message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].

  • repeated Location locations = 1

    A list of locations that matches the specified filter in the request.

  • string next_page_token = 2

    The standard List next-page token.

• rpc GetLocation (GetLocationRequest, Location)

  locations.proto:40

  Gets information about a location.

  message GetLocationRequest

  locations.proto:75

  The request message for [Locations.GetLocation][google.cloud.location.Locations.GetLocation].

  • string name = 1

    Resource name for the location.

A resource that represents Google Cloud Platform location.

Used as response type in: Locations.GetLocation

Used as field type in: ListLocationsResponse

• string name = 1

  Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`

• string location_id = 4

  The canonical id for this location. For example: `"us-east1"`.

• string display_name = 5

  The friendly name for this location, typically a nearby city name. For example, "Tokyo".

• map<string, string> labels = 2

  Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}

• optional protobuf.Any metadata = 3

  Service-specific metadata. For example the available capacity at the given location.