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, univoco solo all'interno dello stesso servizio che lo restituisce in origine. Se utilizzi il mapping HTTP predefinito, |
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. Un oggetto che contiene campi di tipo arbitrario. Un campo aggiuntivo |
done |
Se il valore è |
Campo di unione result . Il risultato dell'operazione, che può essere un error o un response valido. Se done == false , non è impostato né error né response . Se done == true , è possibile impostare esattamente un valore tra error o response . Alcuni servizi potrebbero non fornire il risultato. result può essere solo uno dei seguenti: |
|
error |
L'errore risultante dall'operazione in caso di errore o annullamento. |
response |
La normale risposta dell'operazione in caso di esito positivo. Se il metodo originale non restituisce dati in caso di esito positivo, ad esempio Un oggetto che contiene campi di tipo arbitrario. Un campo aggiuntivo |
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 tipi di dati: codice, messaggio di errore e dettagli dell'errore.
Per ulteriori informazioni su questo modello di errore e su come utilizzarlo, consulta la Guida alla progettazione delle API.
Rappresentazione JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Campi | |
---|---|
code |
Il codice di stato, che deve essere un valore enum di |
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. Un oggetto che contiene campi di tipo arbitrario. Un campo aggiuntivo |
Metodi |
|
---|---|
|
Restituisce lo stato più recente di un'operazione a lunga esecuzione. |