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

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.
ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

Répertorie les informations concernant les emplacements acceptés pour ce service.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.

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 dans le document AIP-160.
page_size

int32

Nombre maximal de résultats à renvoyer. Si cette règle n'est pas configurée, le service en sélectionne une par défaut.
page_token

string

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

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

Ressource représentant 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é.