Package google.longrunning

Index

Opérations

Gère les opérations de longue durée effectuées avec un service API.

Lorsqu'une méthode API prend normalement beaucoup de temps, elle peut être conçue pour renvoyer Operation au client. Le client peut utiliser cette interface pour recevoir la réponse réelle de manière asynchrone en interrogeant la ressource de l'opération, ou transmettre la ressource d'opération à une autre API (telle que l'API Pub/Sub) pour recevoir la réponse. Tout service d'API qui renvoie des opérations de longue durée doit implémenter l'interface Operations afin que les développeurs puissent bénéficier d'une expérience client cohérente.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

Démarre l'annulation asynchrone sur une opération de longue durée. Le serveur fait de son mieux pour annuler l'opération, mais la réussite de l'annulation n'est pas garantie. Si le serveur n'accepte pas cette méthode, il renvoie google.rpc.Code.UNIMPLEMENTED. Les clients peuvent utiliser Operations.GetOperation ou d'autres méthodes pour vérifier si l'annulation a réussi, ou si l'opération a abouti malgré la tentative d'annulation. En cas d'annulation réussie, l'opération n'est pas supprimée, mais elle devient une opération dotée d'une valeur Operation.error avec un code d'état google.rpc.Status.code de 1, correspondant au code Code.CANCELLED.

Champs d'application des autorisations

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

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

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

rpc DeleteOperation(DeleteOperationRequest) returns (Empty)

Supprime une opération de longue durée. Cette méthode indique que le client n'est plus intéressé par le résultat de l'opération. Elle n'annule pas l'opération. Si le serveur n'accepte pas cette méthode, il renvoie google.rpc.Code.UNIMPLEMENTED.

Champs d'application des autorisations

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

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

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

rpc GetOperation(GetOperationRequest) returns (Operation)

Récupère le dernier état d'une opération de longue durée. Cette méthode permet aux clients d'interroger le résultat de l'opération à des intervalles recommandés par le service d'API.

Champs d'application des autorisations

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

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

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

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

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.

Champs d'application des autorisations

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

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

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

rpc WaitOperation(WaitOperationRequest) returns (Operation)

Attend que l'opération de longue durée spécifiée soit terminée ou qu'elle atteigne le délai avant expiration spécifié, renvoyant le dernier état. Si l'opération est déjà effectuée, le dernier état est immédiatement renvoyé. Si le délai avant expiration spécifié est supérieur au délai avant expiration HTTP/RPC par défaut, le délai avant expiration HTTP/RPC est utilisé. Si le serveur n'accepte pas cette méthode, il renvoie google.rpc.Code.UNIMPLEMENTED. Notez que cette méthode répond à un objectif d'optimisation. Elle peut renvoyer le dernier état avant le délai avant expiration spécifié (y compris immédiatement), ce qui signifie qu'une réponse immédiate ne garantit pas l'exécution de l'opération.

Champs d'application des autorisations

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

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

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

CancelOperationRequest

Message de requête pour Operations.CancelOperation.

Champs
name

string

Le nom de ressource de l'opération à annuler.

DeleteOperationRequest

Message de requête pour Operations.DeleteOperation.

Champs
name

string

Le nom de ressource de l'opération à annuler.

GetOperationRequest

Message de requête pour Operations.GetOperation.

Champs
name

string

Nom de ressource de l'opération.

ListOperationsRequest

Message de requête pour Operations.ListOperations.

Champs
name

string

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

string

Le filtre de la liste standard.
page_size

int32

La taille de page de la liste standard.
page_token

string

Le jeton de page de la liste standard.

ListOperationsResponse

Le message de réponse pour Operations.ListOperations.

Champs
operations[]

Operation

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

string

Le jeton de page suivante de la liste standard.

Opération

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

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

Any

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.
done

bool

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, un seul des éléments error ou response peut être défini. Certains services peuvent ne pas fournir le résultat. result ne peut être qu'un des éléments suivants :
error

Status

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

Any

Réponse normale de réussite de l'opération. 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.

WaitOperationRequest

Message de requête pour Operations.WaitOperation.

Champs
name

string

Le nom de ressource de l'opération à attendre.
timeout

Duration

La durée maximale d'attente avant dépassement du délai. Si aucune valeur n'est renseignée, l'attente maximum correspondra au temps autorisé par le protocole HTTP/RPC sous-jacent. Si la date limite du contexte RPC est également spécifiée, la plus courte sera utilisée.