Package google.longrunning

Indice

Operazioni

Gestisce le operazioni a lunga esecuzione con un servizio API.

Quando un metodo API richiede normalmente molto tempo per essere completato, può essere progettato in modo da restituire Operation al client e il client 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 Pub/Sub) per ricevere la risposta. Qualsiasi servizio API che restituisce operazioni a lunga esecuzione dovrebbe implementare l'interfaccia Operations in modo che gli sviluppatori possano avere un'esperienza client coerente.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

Avvia l'annullamento asincrono in un'operazione a lunga esecuzione. Il server fa il possibile per annullare l'operazione, ma l'esito positivo non è garantito. Se il server non supporta questo metodo, restituisce google.rpc.Code.UNIMPLEMENTED. I clienti possono utilizzare Operations.GetOperation o altri metodi per verificare se l'annullamento è riuscito o se l'operazione è stata completata nonostante l'annullamento. Se l'annullamento è andato a buon fine, l'operazione non viene eliminata, ma diventa un'operazione con un valore Operation.error con google.rpc.Status.code pari a 1, corrispondente a Code.CANCELLED.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc DeleteOperation(DeleteOperationRequest) returns (Empty)

Elimina un'operazione a lunga esecuzione. Questo metodo indica che il cliente non è più interessato al risultato dell'operazione. L'operazione non viene annullata. Se il server non supporta questo metodo, restituisce google.rpc.Code.UNIMPLEMENTED.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/cloud-platform
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 il seguente ambito OAuth:

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

Richiede la seguente autorizzazione IAM per la risorsa name:

  • routeoptimization.operations.get

Per ulteriori informazioni, consulta la documentazione di IAM.
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.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc WaitOperation(WaitOperationRequest) returns (Operation)

Attende il completamento dell'operazione a lunga esecuzione specificata o il raggiungimento di un timeout specificato, restituendo lo stato più recente. Se l'operazione è già stata completata, viene immediatamente restituito lo stato più recente. Se il timeout specificato è maggiore del timeout HTTP/RPC predefinito, viene utilizzato il timeout HTTP/RPC. Se il server non supporta questo metodo, restituisce google.rpc.Code.UNIMPLEMENTED. Tieni presente che questo metodo si basa sul criterio del "best effort". Potrebbe restituire lo stato più recente prima del timeout specificato (inclusa la risposta immediata), il che significa che anche una risposta immediata non garantisce il completamento dell'operazione.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

CancelOperationRequest

Il messaggio di richiesta per Operations.CancelOperation.

Campi
name

string

Il nome della risorsa dell'operazione da annullare.

DeleteOperationRequest

Il messaggio di richiesta per Operations.DeleteOperation.

Campi
name

string

Nome della risorsa dell'operazione da eliminare.

GetOperationRequest

Il messaggio di richiesta per Operations.GetOperation.

Campi
name

string

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 elenco standard.
page_size

int32

Le dimensioni della pagina dell'elenco standard.
page_token

string

Il token standard della pagina elenco.

ListOperationsResponse

Il messaggio di risposta per Operations.ListOperations.

Campi
operations[]

Operation

Un elenco di operazioni che corrisponde al filtro specificato nella richiesta.
next_page_token

string

Il token di pagina successiva dell'elenco standard.

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 il nome di una 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 a lunga esecuzione deve documentare l'eventuale tipo di metadati.
done

bool

Se il valore è false, significa che l'operazione è ancora in corso. Se true, l'operazione viene completata e sono disponibili error o response.
Campo unione result. Il risultato dell'operazione, che può essere un valore error o un valore response valido. Se done == false, non sono impostati né error né response. Se done == true, può essere impostato esattamente un valore tra error o response. Alcuni servizi potrebbero non fornire il risultato. 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 e positiva dell'operazione. 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.

WaitOperationRequest

Il messaggio di richiesta per Operations.WaitOperation.

Campi
name

string

Il nome della risorsa dell'operazione in attesa.
timeout

Duration

La durata massima di attesa prima del timeout. Se non la specifichi, il tempo di attesa sarà al massimo quello consentito dal protocollo HTTP/RPC sottostante. Se è specificata anche la scadenza del contesto RPC, verrà utilizzata quella più breve.