Package google.longrunning

Importante: per accedere all'URL elencato tra parentesi, devi connetterti a internet. L'URL viene fornito per l'accesso al di fuori dell'ambiente air-gapped.

Operazioni

Gestisce le operazioni a lunga esecuzione con un servizio API.

Quando un metodo API richiede in genere molto tempo per essere completato, può essere progettato per restituire Operation al client, che può utilizzare questa interfaccia per ricevere la risposta reale in modo asincrono eseguendo il polling della risorsa dell'operazione o passare la risorsa dell'operazione a un'altra API (ad esempio l'API Google Cloud Pub/Sub) per ricevere la risposta. Qualsiasi servizio API che restituisce operazioni a lunga esecuzione deve implementare l'interfaccia Operations in modo che gli sviluppatori possano avere un'esperienza client coerente.

GetOperation
rpc GetOperation(GetOperationRequest) returns (Operation) Recupera l'ultimo stato di un'operazione a lunga esecuzione. I client possono utilizzare questo metodo per eseguire il polling del risultato dell'operazione a intervalli come suggerito dal servizio API.

ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse) Elenca le operazioni che corrispondono al filtro specificato nella richiesta. Se il server non supporta questo metodo, restituisce UNIMPLEMENTED. NOTA: l'associazione name consente ai servizi API di sostituire l'associazione per utilizzare schemi di nomi di risorse diversi, ad esempio users/*/operations. Per sostituire l'associazione, i servizi API possono aggiungere un'associazione come "/v1/{name=users/*}/operations" alla configurazione del servizio. Per la compatibilità con le versioni precedenti, il nome predefinito include l'ID della raccolta di operazioni, ma gli utenti che eseguono la sostituzione devono assicurarsi che l'associazione del nome sia la risorsa padre, senza l'ID della raccolta di operazioni.

GetOperationRequest

Il messaggio di richiesta per Operations.GetOperation.

Campi
name	string Il nome della risorsa dell'operazione.

ListOperationsRequest

Il messaggio di richiesta per Operations.ListOperations.

Campi
name	string Il nome della risorsa padre dell'operazione.
filter	string Il filtro standard dell'elenco.
page_size	int32 Le dimensioni standard della pagina dell'elenco.
page_token	string Il token della pagina dell'elenco standard.

ListOperationsResponse

Il messaggio di risposta per Operations.ListOperations.

Campi
operations[]	Operation Un elenco di operazioni che corrispondono al filtro specificato nella richiesta.
next_page_token	string Il token standard Elenca pagina successiva.

Operazione

Questa risorsa rappresenta un'operazione a lunga esecuzione che è il risultato di una chiamata API di rete.

Campi
name	string Il nome assegnato dal server, che è univoco solo all'interno dello stesso servizio che lo restituisce originariamente. Se utilizzi la mappatura HTTP predefinita, name deve essere un nome risorsa che termina con operations/{unique_id}.
metadata	Any (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any) Metadati specifici del servizio associati all'operazione. In genere contengono informazioni sullo stato di avanzamento e metadati comuni come l'ora di creazione. Alcuni servizi potrebbero non fornire questi metadati. Qualsiasi metodo che restituisce un'operazione a lunga esecuzione deve documentare il tipo di metadati, se presenti.
done	bool Se il valore è false, significa che l'operazione è ancora in corso. Se è true, l'operazione viene completata ed è disponibile error o response.
Campo unione result. Il risultato dell'operazione, che può essere un error o una response valida. Se done == false, né error né response vengono impostati. Se done == true, è possibile impostare esattamente uno tra error e response. Alcuni servizi potrebbero non fornire il risultato. result può essere solo uno dei seguenti tipi:
error	Status (/distributed-cloud/hosted/docs/latest/gdcag/apis/vertex-ai/translation/rpc/google.rpc#google.rpc.Status) Il risultato di errore dell'operazione in caso di errore o annullamento.
response	Any (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any) La risposta normale dell'operazione in caso di esito positivo. Se il metodo originale non restituisce dati in caso di esito positivo, ad esempio Delete, la risposta è google.protobuf.Empty. Se il metodo originale è Get/Create/Update standard, la risposta deve essere la risorsa. Per gli altri metodi, la risposta deve avere il tipo XxxResponse, dove Xxx è il nome del metodo originale. Ad esempio, se il nome del metodo originale è TakeSnapshot(), il tipo di risposta dedotto è TakeSnapshotResponse.