Package google.cloud.location

Indice

Località

Un'interfaccia astratta che fornisce informazioni relative alla località per un servizio. I metadati specifici del servizio vengono forniti tramite il campo Location.metadata.

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

Recupera informazioni su una località.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • observability.locations.get

Per saperne di più, consulta la documentazione di IAM.
ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

Elenca le informazioni sulle località supportate per questo servizio.

Questo metodo elenca le località in base all'ambito della risorsa fornito nel campo ListLocationsRequest.name:

  • Località globali: se name è vuoto, il metodo elenca le località pubbliche disponibili per tutti i progetti.
  • Località specifiche del progetto: se name segue il formato projects/{project}, il metodo elenca le località visibili a quel progetto specifico. Sono incluse le località pubbliche, private o altre località specifiche del progetto abilitate per il progetto.

Per le implementazioni di gRPC e delle librerie client, il nome della risorsa viene passato come campo name. Per le chiamate dirette al servizio, il nome della risorsa viene incorporato nel percorso della richiesta in base all'implementazione e alla versione del servizio specifico.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • observability.locations.list

Per saperne di più, consulta la documentazione di IAM.

GetLocationRequest

Il messaggio di richiesta per Locations.GetLocation.

Campi
name

string

Il nome della risorsa per la posizione.

ListLocationsRequest

Il messaggio di richiesta per Locations.ListLocations.

Campi
name

string

La risorsa proprietaria della raccolta di località, se applicabile.
filter

string

Un filtro per restringere i risultati a un sottoinsieme preferito. Il linguaggio di applicazione dei filtri accetta stringhe come "displayName=tokyo" ed è documentato in modo più dettagliato in AIP-160.
page_size

int32

Il numero massimo di risultati da restituire. Se non viene impostato, il servizio seleziona un valore predefinito.
page_token

string

Un token di pagina ricevuto dal campo next_page_token nella risposta. Invia questo token di pagina per ricevere la pagina successiva.
extra_location_types[]

string

Facoltativo. Non utilizzare questo campo. Non è supportato e viene ignorato, a meno che non sia documentato diversamente. Viene utilizzato principalmente per uso interno.

ListLocationsResponse

Il messaggio di risposta per Locations.ListLocations.

Campi
locations[]

Location

Un elenco di località che corrispondono al filtro specificato nella richiesta.
next_page_token

string

Il token standard Elenca pagina successiva.

Località

Una risorsa che rappresenta una località Google Cloud.

Campi
name

string

Il nome della risorsa per la località, che può variare a seconda delle implementazioni. Ad esempio: "projects/example-project/locations/us-east1"
location_id

string

L'ID canonico per questa località. Ad esempio: "us-east1".
display_name

string

Il nome descrittivo di questa località, in genere il nome di una città vicina. Ad esempio: "Tokyo".
labels

map<string, string>

Gli attributi per la località in più servizi. Ad esempio:

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

Any

Metadati specifici del servizio. Ad esempio: la capacità disponibile nella località specificata.