Méthode : operations.list

Répertorie les opérations qui correspondent au filtre spécifié dans la requête. Si le serveur n'accepte pas cette méthode, il renvoie UNIMPLEMENTED.

REMARQUE : La liaison name permet aux services de l'API de remplacer la liaison pour utiliser différents schémas de noms de ressources, tels que users/*/operations. Pour remplacer la liaison, les services de l'API peuvent ajouter une liaison telle que "/v1/{name=users/*}/operations" à leur configuration. Pour assurer la rétrocompatibilité, le nom par défaut inclut l'ID de collection d'opérations. Toutefois, les utilisateurs qui le remplacent doivent s'assurer que la liaison de nom est la ressource parente, sans l'ID de collection d'opérations.

Requête HTTP

GET https://bigqueryreservation.googleapis.com/v1/{name}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Le nom de la ressource parente de l'opération.

Paramètres de requête

Paramètres
filter

string

Le filtre de la liste standard.

pageSize

integer

La taille de page de la liste standard.

pageToken

string

Le jeton de page de la liste standard.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Message de réponse pour Operations.ListOperations

Représentation JSON

{
  "operations": [
    {
      object (Operation)
    }
  ],
  "nextPageToken": string
}
Champs
operations[]

object (Operation)

La liste des opérations qui correspondent au filtre spécifié dans la requête.

nextPageToken

string

Le jeton de page suivante de la liste standard.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Présentation de l'authentification.

Opération

Cette ressource représente une opération de longue durée résultant d'un appel d'API réseau.

Représentation 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.
}
Champs
name

string

Nom attribué par le serveur. Unique au sein du service qui le renvoie initialement. Si vous utilisez le mappage HTTP par défaut, le champ name doit être un nom de ressource se terminant par operations/{unique_id}.

metadata

object

Métadonnées spécifiques au service associées à l'opération. Ce champ contient généralement des informations de progression et des métadonnées courantes telles que la date de création. Certains services peuvent ne pas fournir ce genre de métadonnées. Toute méthode renvoyant une opération de longue durée doit indiquer le type de métadonnées, le cas échéant.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

done

boolean

Si la valeur est false, cela signifie que l'opération est toujours en cours. Si elle est définie sur true, l'opération est terminée, et un message error ou response est disponible.

Champ d'union result. Résultat de l'opération, qui peut être une erreur (message error) ou une réponse valide (message response). Si done == false, ni error, ni response ne sont définis. Si done == true, une seule des options error ou response est définie. result ne peut être qu'un des éléments suivants :
error

object (Status)

Résultat d'erreur de l'opération en cas d'échec ou d'annulation.

response

object

Réponse normale de l'opération lorsqu'elle aboutit. Si la méthode d'origine ne renvoie aucune donnée en cas de réussite (telle que Delete), la réponse est google.protobuf.Empty. Si la méthode d'origine est une méthode Get/Create/Update standard, la réponse doit correspondre à la ressource. Pour les autres méthodes, la réponse doit avoir le type XxxResponse, où Xxx est le nom de la méthode d'origine. Par exemple, si le nom de la méthode d'origine est TakeSnapshot(), le type de réponse déduit est TakeSnapshotResponse.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

Essayer