Risorsa: operazione
Questa risorsa rappresenta un'operazione a lunga esecuzione risultante da una chiamata API di rete.
Rappresentazione JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Campi | |
---|---|
name |
Il nome assegnato dal server, che è univoco soltanto all'interno dello stesso servizio che lo restituisce originariamente. Se utilizzi la mappatura HTTP predefinita, |
metadata |
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 |
Se il valore è |
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 |
Il risultato dell'errore dell'operazione in caso di errore o di annullamento. |
response |
La risposta normale e riuscita dell'operazione. Se il metodo originale non restituisce dati in caso di esito positivo, ad esempio |
Stato
Il tipo Status
definisce un modello di errore logico adatto a diversi ambienti di programmazione, tra cui API REST e API RPC. È utilizzato da gRPC. Ogni messaggio Status
contiene tre dati: codice, messaggio di errore e dettagli dell'errore.
Per saperne di più su questo modello di errore e su come utilizzarlo, consulta la Guida alla progettazione dell'API.
Rappresentazione JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Campi | |
---|---|
code |
Il codice di stato, che deve essere un valore enum pari a |
message |
Un messaggio di errore rivolto agli sviluppatori, che deve essere in inglese. Qualsiasi messaggio di errore rivolto agli utenti deve essere localizzato e inviato nel campo |
details[] |
Un elenco di messaggi con i dettagli dell'errore. Le API possono utilizzare un insieme comune di tipi di messaggi. |
Metodi |
|
---|---|
|
Recupera lo stato più recente di un'operazione a lunga esecuzione. |