Package google.longrunning

Indice

• Operations (interfaccia)
• CancelOperationRequest (messaggio)
• GetOperationRequest (messaggio)
• ListOperationsRequest (messaggio)
• ListOperationsResponse (messaggio)
• Operation (messaggio)

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 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 di lunga durata deve implementare l'interfaccia Operations in modo che gli sviluppatori possano usufruire di un'esperienza client coerente.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty) Avvia l'annullamento asincrono di un'operazione a lunga esecuzione. Il server fa del suo meglio 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. In caso di annullamento riuscito, l'operazione non viene eliminata, ma diventa un'operazione con un valore Operation.error con un google.rpc.Status.code di 1, corrispondente a Code.CANCELLED. Ambiti di autorizzazione Richiede uno dei seguenti ambiti OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite Per ulteriori informazioni, consulta Authentication Overview.

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/discoveryengine.readwrite Per ulteriori informazioni, consulta Authentication Overview. Autorizzazioni IAM Richiede la seguente autorizzazione IAM per la risorsa name: discoveryengine.operations.get Per saperne di più, 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 uno dei seguenti ambiti OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite Per ulteriori informazioni, consulta Authentication Overview. Autorizzazioni IAM Richiede la seguente autorizzazione IAM per la risorsa name: discoveryengine.operations.list Per saperne di più, consulta la documentazione di IAM.

CancelOperationRequest

Il messaggio di richiesta per Operations.CancelOperation.

Campi
name	string Il nome della risorsa dell'operazione da annullare.

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 normalmente, mentre quelle non raggiungibili vengono restituite nel campo [ListOperationsResponse.unreachable]. Può essere solo true durante la lettura tra le 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 diversamente documentato 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 di pagina successiva standard dell'elenco.
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 di 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 dei valori error o response. Alcuni servizi potrebbero non fornire il risultato. result può essere solo uno dei seguenti:
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.