Pacchetto google.longrun

Indice

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

Suite operativa

Gestisce operazioni a lunga esecuzione con un servizio API.

Se normalmente un metodo API richiede molto tempo, 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 passare la risorsa dell'operazione a un'altra API (ad esempio, l'API Google Cloud Pub/Sub) per ricevere la risposta. Tutti i servizi API che restituiscono operazioni di lunga durata devono implementare l'interfaccia Operations in modo che gli sviluppatori possano avere un'esperienza client coerente.

GetOperation

GetOperation
`rpc GetOperation(GetOperationRequest) returns (Operation)` Visualizza 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-healthcare` `https://www.googleapis.com/auth/cloud-platform` Per ulteriori informazioni, consulta la sezione Panoramica dell'autenticazione.

rpc GetOperation(GetOperationRequest) returns (Operation)

Visualizza 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-healthcare
https://www.googleapis.com/auth/cloud-platform

Per ulteriori informazioni, consulta la sezione Panoramica dell'autenticazione.

ListOperations

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 eseguire l'override dell'associazione per utilizzare schemi di nomi di risorse diversi, come `users//operations`. Per eseguire l'override dell'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 raccolta delle operazioni, tuttavia se esegui l'override degli utenti devi assicurarti che l'associazione del nome sia la risorsa principale, senza l'ID raccolta delle operazioni. Ambiti di autorizzazione Richiede uno dei seguenti ambiti OAuth: `https://www.googleapis.com/auth/cloud-healthcare` `https://www.googleapis.com/auth/cloud-platform` Per ulteriori informazioni, consulta la sezione Panoramica dell'autenticazione.

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 eseguire l'override dell'associazione per utilizzare schemi di nomi di risorse diversi, come users/*/operations. Per eseguire l'override dell'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 raccolta delle operazioni, tuttavia se esegui l'override degli utenti devi assicurarti che l'associazione del nome sia la risorsa principale, senza l'ID raccolta delle operazioni.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la sezione Panoramica dell'autenticazione.

GetOperationRequest

Il messaggio di richiesta per Operations.GetOperation.

Campi

Campi
`name`	`string` Il nome della risorsa dell'operazione.

name

string

Il nome della risorsa dell'operazione.

ListOperationsRequest

Il messaggio di richiesta per Operations.ListOperations.

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

ListOperationsResponse

Il messaggio di risposta per Operations.ListOperations.

Campi

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

operations[]

Operation

Un elenco di operazioni che corrispondono al filtro specificato nella richiesta.

next_page_token

string

Il token standard dell'elenco della 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 in origine. Se utilizzi il mapping HTTP predefinito, `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 tali metadati. Qualsiasi metodo che restituisca un'operazione a lunga esecuzione dovrebbe documentare il tipo di metadati, se disponibile.
`done`	`bool` Se il valore è `false`, significa che l'operazione è ancora in corso. Se il comando `true` è completato, l'operazione è completata ed è disponibile `error` o `response`.
Campo `result`. Il risultato dell'operazione, che può essere un `error` o un `response` valido. Se `done` == `false`, non viene impostato né `error` né `response`. Se `done` == `true`, viene impostato esattamente uno tra `error` e `response`. `result` può essere solo uno dei seguenti:
`error`	`Status` Il risultato dell'errore in caso di errore o annullamento.
`response`	`Any` Risposta normale dell'operazione in caso di esito positivo. Se il metodo originale non restituisce dati su operazioni riuscite, come `Delete`, la risposta è `google.protobuf.Empty`. Se il metodo originale è standard `Get`/`Create`/`Update`, la risposta dovrebbe essere la risorsa. Per altri metodi, la risposta dovrebbe avere il tipo `XxxResponse`, dove `Xxx` è il nome originale del metodo. Ad esempio, se il nome del metodo originale è `TakeSnapshot()`, il tipo di risposta dedotto è `TakeSnapshotResponse`.