Package google.cloud.location

Index

Emplacements

Interface abstraite qui fournit des informations relatives aux emplacements pour un service. Les métadonnées propres au service sont fournies via le champ Location.metadata.

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

Obtient des informations sur un emplacement.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • observability.locations.get

Pour en savoir plus, consultez la documentation IAM.
ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

Liste les informations relatives aux emplacements disponibles pour ce service.

Cette méthode liste les emplacements en fonction du champ d'application de la ressource fourni dans le champ ListLocationsRequest.name :

  • Emplacements mondiaux : si name est vide, la méthode liste les emplacements publics disponibles pour tous les projets.
  • Emplacements spécifiques à un projet : si name suit le format projects/{project}, la méthode liste les emplacements visibles pour ce projet spécifique. Cela inclut les emplacements publics, privés ou autres emplacements spécifiques à un projet activés pour le projet.

Pour les implémentations gRPC et de bibliothèque cliente, le nom de la ressource est transmis en tant que champ name. Pour les appels de service directs, le nom de la ressource est intégré au chemin de la requête en fonction de l'implémentation et de la version spécifiques du service.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • observability.locations.list

Pour en savoir plus, consultez la documentation IAM.

GetLocationRequest

Message de requête pour Locations.GetLocation.

Champs
name

string

Nom de la ressource pour l'emplacement.

ListLocationsRequest

Message de requête pour Locations.ListLocations.

Champs
name

string

La ressource qui possède la collection d'emplacements, le cas échéant.
filter

string

Un filtre permettant de limiter les résultats à un sous-ensemble préféré. Le langage de filtrage accepte des chaînes telles que "displayName=tokyo". Il est décrit plus en détail sur la page AIP-160.
page_size

int32

Nombre maximal de résultats à renvoyer. Si ce champ n'est pas défini, le service sélectionne une valeur par défaut.
page_token

string

Jeton de page reçu du champ next_page_token dans la réponse. Envoyez ce jeton de page pour recevoir la page suivante.
extra_location_types[]

string

Facultatif. N'utilisez pas ce champ. Il n'est pas compatible et est ignoré, sauf indication contraire explicite. Il est principalement destiné à un usage interne.

ListLocationsResponse

Message de réponse pour Locations.ListLocations.

Champs
locations[]

Location

La liste des emplacements correspondant au filtre spécifié dans la requête.
next_page_token

string

Le jeton de page suivante de la liste standard.

Emplacement

Une ressource qui représente un emplacement Google Cloud.

Champs
name

string

Nom de ressource pour l'emplacement. Ce nom peut varier d'une mise en œuvre à l'autre. Par exemple : "projects/example-project/locations/us-east1"
location_id

string

ID canonique de l'emplacement. Exemple : "us-east1".
display_name

string

Nom convivial de cet emplacement, généralement celui d'une ville à proximité. Par exemple, "Tokyo".
labels

map<string, string>

Attributs interservices pour l'emplacement. Par exemple :

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

Any

Métadonnées spécifiques au service. Il peut s'agir par exemple de la capacité disponible dans l'emplacement donné.