Operation
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 result can be only one of the following:
"error": {
object (Status )
},
"response": {
"@type": string,
field1: ...,
...
}
// End of list of possible types for union field result .
} |
Campi |
name |
string
Il nome assegnato dal server, che è univoco soltanto all'interno dello stesso servizio che lo restituisce originariamente. Se utilizzi la mappatura HTTP predefinita, name deve essere il nome di una risorsa che termina con operations/{unique_id} .
|
metadata |
object
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 "@type" contiene un URI che identifica il tipo. Esempio: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
done |
boolean
Se il valore è false , significa che l'operazione è ancora in corso. Se true , l'operazione viene completata e sono disponibili error o response .
|
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 |
object (Status )
Il risultato dell'errore dell'operazione in caso di errore o di annullamento.
|
response |
object
La risposta normale e riuscita 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 è standard Get /Create /Update , la risposta dovrebbe essere la risorsa. Per altri metodi, la risposta deve essere di tipo XxxResponse , dove Xxx è il nome del metodo originale. Ad esempio, se il nome del metodo originale è TakeSnapshot() , il tipo di risposta dedotto è TakeSnapshotResponse . Un oggetto che contiene campi di tipo arbitrario. Un campo aggiuntivo "@type" contiene un URI che identifica il tipo. Esempio: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2024-09-10 UTC.
[null,null,["Ultimo aggiornamento 2024-09-10 UTC."],[[["This resource describes the JSON representation of a long-running operation initiated by a network API call."],["The representation includes fields for operation name (`name`), metadata (`metadata`), completion status (`done`), and result (`result`)."],["The `result` field provides either an error (`error`) or a response (`response`) based on the operation outcome."],["While the operation is in progress, `done` is `false` and neither `error` nor `response` are set; upon completion, `done` becomes `true` and either `error` or `response` is populated."]]],[]]