Package google.cloud.location

Índice

Locais

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

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

Recebe informações sobre um local.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

Lista informações sobre os locais compatíveis com este serviço.

Esse método lista locais com base no escopo do recurso fornecido no campo ListLocationsRequest.name:

  • Locais globais: se name estiver vazio, o método vai listar os locais públicos disponíveis para todos os projetos.
  • Locais específicos do projeto: se name seguir o formato projects/{project}, o método vai listar os locais visíveis para esse projeto específico. Isso inclui locais públicos, particulares ou outros específicos do projeto que estão ativados para ele.

Para implementações de gRPC e biblioteca de cliente, o nome do recurso é transmitido como o campo name. Para chamadas diretas de serviço, o nome do recurso é incorporado ao caminho da solicitação com base na implementação e versão específicas do serviço.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

GetLocationRequest

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

Campos
name

string

Nome do recurso para o local.

ListLocationsRequest

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

Campos
name

string

O recurso que tiver o conjunto de locais, se aplicável.
filter

string

Um filtro para restringir os resultados a um subconjunto preferido. A linguagem do filtro 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 seguinte.
extra_location_types[]

string

Opcional. Não use esse campo, a menos que esteja documentado de outra forma. Ele se destina principalmente para uso interno.

ListLocationsResponse

A mensagem de resposta para Locations.ListLocations.

Campos
locations[]

Location

Uma lista de locais correspondente ao filtro especificado na solicitação.
next_page_token

string

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

Local

Um recurso que representa um local do Google Cloud.

Campos
name

string

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

string

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

string

O nome legível desse local, geralmente o nome de uma cidade próxima. Por exemplo, "Tóquio".
labels

map<string, string>

Atributos entre serviços do local. Por exemplo:

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

Any

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