Package google.cloud.location

Índice

Ubicaciones

Una interfaz abstracta que proporciona información relacionada con la ubicación para un servicio. Los metadatos específicos del servicio se proporcionan mediante el campo Location.metadata.

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

Permite obtener información sobre una ubicación.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.
ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

Permite mostrar una lista con información sobre las ubicaciones compatibles con este servicio.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

GetLocationRequest

El mensaje de solicitud para Locations.GetLocation.

Campos
name

string

El nombre de recurso de la ubicación.

ListLocationsRequest

El mensaje de solicitud para Locations.ListLocations.

Campos
name

string

El recurso propietario de la colección de ubicaciones, si corresponde.
filter

string

Un filtro para limitar los resultados a un subconjunto preferido. El lenguaje de filtrado acepta cadenas como "displayName=tokyo" y se documenta con más detalle en AIP-160.
page_size

int32

La cantidad máxima de resultados que se mostrarán. Si no la estableces, el servicio seleccionará un valor predeterminado.
page_token

string

Un token de página recibido del campo next_page_token de la respuesta. Envía ese token de página para recibir la página siguiente.

ListLocationsResponse

El mensaje de respuesta para Locations.ListLocations.

Campos
locations[]

Location

Una lista de ubicaciones que coincide con el filtro especificado en la solicitud.
next_page_token

string

El token de página siguiente de lista estándar.

Ubicación

Un recurso que representa una ubicación de Google Cloud.

Campos
name

string

Nombre de recurso para la ubicación, que puede variar entre implementaciones. Por ejemplo: "projects/example-project/locations/us-east1"
location_id

string

El ID canónico de esta ubicación. Por ejemplo: "us-east1".
display_name

string

El nombre sencillo de la ubicación, por lo general, es el nombre de una ciudad cercana. Por ejemplo: “Tokio”.
labels

map<string, string>

Atributos de la ubicación entre servicios. Por ejemplo:

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

Any

Metadatos específicos del servicio. Por ejemplo, la capacidad disponible en la ubicación específica.