Risorsa REST: projects.locations.sets.operations

Risorsa: operazione

Questa risorsa rappresenta un'operazione a lunga esecuzione che è il risultato di 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 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/{uniqueId}.

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 tali metadati. Qualsiasi metodo che restituisca un'operazione a lunga esecuzione dovrebbe documentare il tipo di metadati, se disponibile.

Un oggetto contenente 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 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é errorresponse. Se done == true, viene impostato esattamente uno tra error e response. result può essere solo uno dei seguenti:
error

object (Status)

Il risultato dell'errore in caso di errore o annullamento.

response

object

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.

Un oggetto contenente campi di tipo arbitrario. Un campo aggiuntivo "@type" contiene un URI che identifica il tipo. Esempio: { "id": 1234, "@type": "types.example.com/standard/id" }.

Metodi

get

Visualizza lo stato più recente di un'operazione a lunga esecuzione.

list

Elenca le operazioni che corrispondono al filtro specificato nella richiesta.