Package google.cloud.location

Indice

Emplacements

Interface abstraite qui fournit des informations relatives à l'emplacement d'un service. Les métadonnées spécifiques au service sont fournies via le champ Location.metadata .

ObtenirEmplacement

rpc GetLocation( GetLocationRequest ) returns ( Location )

Obtient des informations sur un emplacement.

Portées des autorisations

Nécessite l'une des étendues OAuth suivantes :

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

Pour plus d'informations, consultez la Présentation de l'authentification .

Liste des emplacements

rpc ListLocations( ListLocationsRequest ) returns ( ListLocationsResponse )

Répertorie les informations sur les emplacements pris en charge pour ce service.

Portées des autorisations

Nécessite l'une des étendues OAuth suivantes :

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

Pour plus d'informations, consultez la Présentation de l'authentification .

ObtenirLocationRequest

Le message de demande pour Locations.GetLocation .

Des champs
name

string

Nom de la ressource pour l'emplacement.

ListeEmplacementsDemande

Le message de demande pour Locations.ListLocations .

Des champs
name

string

Ressource propriétaire de la collection d'emplacements, le cas échéant.

filter

string

Un filtre pour affiner les résultats à un sous-ensemble préféré. Le langage de filtrage accepte des chaînes telles que "displayName=tokyo" et est documenté plus en détail dans AIP-160 .

page_size

int32

Le nombre maximum de résultats à renvoyer. S’il n’est pas défini, le service sélectionne une valeur par défaut.

page_token

string

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

ListeEmplacementsRéponse

Le message de réponse pour Locations.ListLocations .

Des champs
locations[]

Location

Liste des emplacements qui correspondent au filtre spécifié dans la demande.

next_page_token

string

Le jeton standard de la page suivante de la liste.

Emplacement

Ressource qui représente un emplacement Google Cloud.

Des champs
name

string

Nom de la ressource pour l'emplacement, qui peut varier selon les implémentations. Par exemple : "projects/example-project/locations/us-east1"

location_id

string

L'identifiant canonique de cet emplacement. Par exemple : "us-east1" .

display_name

string

Nom convivial de cet emplacement, généralement un nom de ville voisine. 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. Par exemple la capacité disponible à un emplacement donné.