Package google.cloud.location

Índice

• Locations (interfaz)
• GetLocationRequest (mensaje)
• ListLocationsRequest (mensaje)
• ListLocationsResponse (mensaje)
• Location (mensaje)

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. Alcances de autorización Requiere el siguiente permiso de OAuth: https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Authentication Overview.

ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse) Permite mostrar una lista con información sobre las ubicaciones compatibles con este servicio. Este método muestra ubicaciones según el alcance del recurso proporcionado en el campo ListLocationsRequest.name: Ubicaciones globales: Si name está vacío, el método muestra las ubicaciones públicas disponibles para todos los proyectos. Ubicaciones específicas del proyecto: Si name sigue el formato projects/{project}, el método muestra las ubicaciones visibles para ese proyecto específico. Esto incluye ubicaciones públicas, privadas o de otro tipo específicas del proyecto habilitadas para el proyecto. Para las implementaciones de gRPC y de la biblioteca cliente, el nombre del recurso se pasa como el campo name. Para las llamadas directas al servicio, el nombre del recurso se incorpora a la ruta de acceso de la solicitud según la implementación y la versión específicas del servicio. Alcances de autorización Requiere el siguiente permiso de OAuth: https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Authentication Overview.

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 del conjunto de ubicaciones, si corresponde.
filter	string Es un filtro que acota 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 se configura, el servicio selecciona una configuración predeterminada.
page_token	string Es un token de página recibido del campo next_page_token en la respuesta. Envía ese token de página para recibir la página siguiente.
extra_location_types[]	string Es opcional. No uses este campo a menos que se documente explícitamente lo contrario. Esto es principalmente para uso interno.

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 Es 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> Son los 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.