Package google.longrunning

Indice

Opérations

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

Lorsqu'une méthode API prend normalement beaucoup de temps, elle peut être conçue pour renvoyer Operation au client, et le client peut utiliser cette interface pour recevoir la réponse réelle de manière asynchrone en interrogeant la ressource d'opération, ou transmettre la ressource d'opération à une autre API ( comme l'API Pub/Sub) pour recevoir la réponse. Tout service 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.

AnnulerOpération

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 le succès n'est pas garanti. Si le serveur ne prend pas en charge 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 s'est terminée malgré l'annulation. En cas d'annulation réussie, l'opération n'est pas supprimée ; à la place, cela devient une opération avec une valeur Operation.error avec un google.rpc.Status.code de 1, correspondant à Code.CANCELLED .

Portées des autorisations

Nécessite l'une des étendues OAuth suivantes :

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

Pour plus d'informations, consultez la Présentation de l'authentification .

Opération Supprimer

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. Cela n'annule pas l'opération. Si le serveur ne prend pas en charge cette méthode, il renvoie google.rpc.Code.UNIMPLEMENTED .

Portées des autorisations

Nécessite l'une des étendues OAuth suivantes :

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

Pour plus d'informations, consultez la Présentation de l'authentification .

ObtenirOpération

rpc GetOperation( GetOperationRequest ) returns ( Operation )

Obtient le dernier état d’une opération de longue durée. Les clients peuvent utiliser cette méthode pour interroger le résultat de l'opération à intervalles recommandés par le service API.

Portées des autorisations

Nécessite l'une des étendues OAuth suivantes :

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

Pour plus d'informations, consultez la Présentation de l'authentification .

ListeOpérations

rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse )

Répertorie les opérations qui correspondent au filtre spécifié dans la demande. Si le serveur ne prend pas en charge cette méthode, il renvoie UNIMPLEMENTED .

Portées des autorisations

Nécessite l'une des étendues OAuth suivantes :

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

Pour plus d'informations, consultez la Présentation de l'authentification .

AttendreOpération

rpc WaitOperation( WaitOperationRequest ) returns ( Operation )

Attend que l'opération de longue durée spécifiée soit terminée ou atteigne au plus un délai d'attente 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 d'expiration spécifié est supérieur au délai d'expiration HTTP/RPC par défaut, le délai d'expiration HTTP/RPC est utilisé. Si le serveur ne prend pas en charge cette méthode, il renvoie google.rpc.Code.UNIMPLEMENTED . Notez que cette méthode s'effectue au mieux. Il peut renvoyer le dernier état avant le délai d'attente spécifié (y compris immédiatement), ce qui signifie que même une réponse immédiate ne garantit pas que l'opération est effectuée.

Portées des autorisations

Nécessite l'une des étendues OAuth suivantes :

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

Pour plus d'informations, consultez la Présentation de l'authentification .

AnnulerOperationRequest

Le message de demande pour Operations.CancelOperation .

Des champs
name

string

Nom de la ressource d'opération à annuler.

SupprimerOperationRequest

Le message de demande pour Operations.DeleteOperation .

Des champs
name

string

Nom de la ressource d'opération à supprimer.

GetOperationRequest

Le message de demande pour Operations.GetOperation .

Des champs
name

string

Le nom de la ressource d’opération.

ListOperationsRequest

Le message de demande pour Operations.ListOperations .

Des champs
name

string

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

filter

string

Le filtre de liste standard.

page_size

int32

Taille de page de liste standard.

page_token

string

Le jeton de page de liste standard.

ListeOpérationsRéponse

Le message de réponse pour Operations.ListOperations .

Des champs
operations[]

Operation

Liste des opérations qui correspondent au filtre spécifié dans la demande.

next_page_token

string

Le jeton standard de la page suivante de la liste.

Opération

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

Des champs
name

string

Le nom attribué par le serveur, qui est unique uniquement au sein du même service qui l'a renvoyé à l'origine. Si vous utilisez le mappage HTTP par défaut, le 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. Il contient généralement des informations sur la progression et des métadonnées communes telles que l'heure de création. Certains services peuvent ne pas fournir de telles métadonnées. Toute méthode qui renvoie une opération de longue durée doit documenter 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 true , l’opération est terminée et une error ou response est disponible.

result du champ Union. Le résultat de l'opération, qui peut être soit une error , soit une response valide. Si done == false , ni error ni response ne sont définies. Si done == true , exactement une error ou response peut être définie. Certains services peuvent ne pas fournir le résultat. result ne peut être que l'un des éléments suivants :
error

Status

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

response

Any

La réponse normale et réussie de l’opération. Si la méthode d'origine ne renvoie aucune donnée en cas de succès, telle que Delete , la réponse est google.protobuf.Empty . Si la méthode d'origine est standard Get / Create / Update , la réponse doit être la ressource. Pour les autres méthodes, la réponse doit être du 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

Le message de demande pour Operations.WaitOperation .

Des champs
name

string

Nom de la ressource d’opération à attendre.

timeout

Duration

La durée maximale d'attente avant l'expiration. Si ce champ est laissé vide, l'attente sera au maximum égale à la durée autorisée 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.