Package google.cloud.location

Índice

Localizações

Uma interface abstrata que fornece informações relacionadas à localização de um serviço. Os metadados específicos do serviço são fornecidos por meio do campo Location.metadata .

Obter localização

rpc GetLocation( GetLocationRequest ) returns ( Location )

Obtém informações sobre um local.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para obter mais informações, consulte Visão geral da autenticação .

ListarLocais

rpc ListLocations( ListLocationsRequest ) returns ( ListLocationsResponse )

Lista informações sobre os locais com suporte para este serviço.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para obter mais informações, consulte Visão geral da autenticação .

GetLocationRequest

A mensagem de solicitação para Locations.GetLocation .

Campos
name

string

Nome do recurso para o local.

ListaLocationsRequest

A mensagem de solicitação para Locations.ListLocations .

Campos
name

string

O recurso que possui a coleção de locais, se aplicável.

filter

string

Um filtro para restringir os resultados a um subconjunto preferido. A linguagem de filtragem aceita strings como "displayName=tokyo" e está documentada com mais detalhes em AIP-160 .

page_size

int32

O número máximo de resultados a serem retornados. Se não for definido, o serviço selecionará um padrão.

page_token

string

Um token de página recebido do campo next_page_token na resposta. Envie esse token de página para receber a página subsequente.

ListLocationsResponse

A mensagem de resposta para Locations.ListLocations .

Campos
locations[]

Location

Uma lista de locais que correspondem ao filtro especificado na solicitação.

next_page_token

string

O token padrão da próxima página da lista.

Localização

Um recurso que representa um local do Google Cloud.

Campos
name

string

Nome do recurso para o local, que pode variar entre implementações. Por exemplo: "projects/example-project/locations/us-east1"

location_id

string

O ID canônico deste local. Por exemplo: "us-east1" .

display_name

string

O nome amigável deste local, normalmente o nome de uma cidade próxima. Por exemplo, "Tóquio".

labels

map<string, string>

Atributos de vários serviços para o local. Por exemplo

{"cloud.googleapis.com/region": "us-east1"}
metadata

Any

Metadados específicos do serviço. Por exemplo, a capacidade disponível em um determinado local.