Package google.longrunning

Indice

Operazioni

Gestisce le operazioni a lunga esecuzione con un servizio API.

Quando un metodo API richiede normalmente ta/1.13.0/docs/ 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 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.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

Avvia l'annullamento asincrono di un'operazione a lunga esecuzione. Il server fa il possibile per annullare l'operazione, ma la riuscita non è garantita. Se il server non supporta questo metodo, restituisce google.rpc.Code.UNIMPLEMENTED. I client possono utilizzare Operations.GetOperation o altri metodi per verificare se l'annullamento è andato a buon fine 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 un 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

Per saperne di più, consulta la Authentication Overview.
DeleteOperation

rpc DeleteOperation(DeleteOperationRequest) returns (Empty)

Elimina un'operazione a lunga esecuzione. Questo metodo indica che il client 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

Per saperne di più, consulta la Authentication Overview.
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.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.
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

Per saperne di più, consulta la Authentication Overview.
WaitOperation

rpc WaitOperation(WaitOperationRequest) returns (Operation)

Attende il completamento dell'operazione a lunga esecuzione specificata o il raggiungimento del timeout massimo specificato, restituendo lo stato più recente. Se l'operazione è già stata completata, viene restituito immediatamente l'ultimo stato. 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 viene applicato al meglio delle possibilità nel singolo caso. Potrebbe restituire lo stato più recente prima del timeout specificato (anche immediatamente), il che significa che anche una risposta immediata non garantisce che l'operazione sia stata completata.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

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

Il nome della risorsa dell'operazione da eliminare.

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.
return_partial_success

bool

Se impostato su true, le operazioni raggiungibili vengono restituite come norm/1.13.0/docs/ e quelle non raggiungibili vengono restituite nel campo ListOperationsResponse.unreachable.

Può essere solo true in caso di lettura tra raccolte. Ad esempio, quando parent è impostato su "projects/example/locations/-".

Questo campo non è supportato per impostazione predefinita e genererà un errore UNIMPLEMENTED se impostato, a meno che non sia esplicitamente documentato diversamente nella documentazione specifica del servizio o del prodotto.

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.
unreachable[]

string

Elenco non ordinato. Risorse non raggiungibili. Viene compilato quando la richiesta imposta ListOperationsRequest.return_partial_success e legge tra le raccolte. Ad esempio, quando si tenta di elencare tutte le risorse in tutte le località supportate.

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

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

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

Any

La risposta normale e con esito positivo 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 è 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.

WaitOperationRequest

Il messaggio di richiesta per Operations.WaitOperation.

Campi
name

string

Il nome della risorsa dell'operazione da attendere.
timeout

Duration

La durata massima dell'attesa prima del timeout. Se non viene specificato, l'attesa sarà al massimo il tempo consentito dal protocollo HTTP/RPC sottostante. Se viene specificata anche la scadenza del contesto RPC, verrà utilizzata quella più breve.