Package google.longrunning

Indice

Operazioni

Gestisce le operazioni a lunga esecuzione con un servizio API.

Quando un metodo dell'API richiede normalmente 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 oppure può 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 di lunga durata deve implementare l'interfaccia Operations in modo che gli sviluppatori possano avere un'esperienza client coerente.

GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

Recupera lo stato più recente di un'operazione a lunga esecuzione. I client possono utilizzare questo metodo per eseguire il polling del risultato dell'operazione a intervalli come consigliato dal servizio API.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.

GetOperationRequest

Il messaggio di richiesta per Operations.GetOperation.

Campi
name

string

Il nome della risorsa dell'operazione.

Operazione

Questa risorsa rappresenta un'operazione a lunga esecuzione che è il risultato di una chiamata all'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 di risorsa che termina con operations/{unique_id}.

metadata

Any

Metadati specifici del servizio associati all'operazione. In genere contiene informazioni sull'avanzamento e metadati comuni come l'ora di creazione. Alcuni servizi potrebbero non fornire questi metadati. Qualsiasi metodo che restituisce un'operazione di lunga durata deve documentare il tipo di metadati, se presente.

done

bool

Se il valore è false, significa che l'operazione è ancora in corso. Se true, l'operazione è completata e error o response è disponibile.

Campo unione result. Il risultato dell'operazione, che può essere un error o un response valido. Se done == false, non è impostato né error né response. Se done == true, è impostato esattamente uno tra error o response. result può essere solo uno dei seguenti:
error

Status

Il risultato dell'errore dell'operazione in caso di fallimento o annullamento.

response

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 è standard Get/Create/Update, la risposta deve essere la risorsa. Per 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.