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 all'interno dello stesso servizio che lo restituisce in origine. Se utilizzi la mappatura HTTP predefinita, |
metadata |
Questo campo conterrà un oggetto Un oggetto contenente campi di tipo arbitrario. Un campo aggiuntivo |
done |
Se il valore è |
Campo di unione result . Il risultato dell'operazione, che può essere error o response valido. Se done == false , né error né response sono impostati. Se done == true , puoi impostare esattamente uno tra error o response . Alcuni servizi potrebbero non fornire il risultato. result può essere solo uno dei seguenti: |
|
error |
Questo campo non verrà sempre impostato se l'operazione viene creata da |
response |
Questo campo conterrà un oggetto Un oggetto contenente 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. Viene utilizzato da gRPC. Ogni messaggio Status
contiene tre dati: codice di errore, messaggio di errore e dettagli dell'errore.
Puoi trovare ulteriori informazioni su questo modello di errore e su come utilizzarlo nella 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 dovrebbe essere in inglese. Qualsiasi messaggio di errore rivolto all'utente deve essere localizzato e inviato nel campo |
details[] |
Un elenco dei messaggi che contengono i dettagli dell'errore. Esiste un insieme comune di tipi di messaggi che le API possono utilizzare. Un oggetto contenente campi di tipo arbitrario. Un campo aggiuntivo |
Metodi |
|
---|---|
|
Visualizza lo stato più recente di un'operazione a lunga esecuzione. |