Package google.longrunning

Index

• Operations (interface)
• CancelOperationRequest (message)
• DeleteOperationRequest (message)
• GetOperationRequest (message)
• ListOperationsRequest (message)
• ListOperationsResponse (message)
• Operation (message)
• WaitOperationRequest (message)

Operations

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 pour aboutir, elle peut être conçue pour renvoyer une 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 en la transmettant à une autre API (telle que l'API Google Cloud 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) renvoie (Empty) Démarre l'annulation asynchrone sur une opération de longue durée. Le serveur tente au mieux d'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 de réussite de l'annulation, l'opération n'est pas supprimée. Au lieu de cela, l'opération prend la valeur Operation.error et son code d'état google.rpc.Status.code passe à 1, ce qui correspond à Code.CANCELLED. Champs d'application des autorisations Requiert le champ d'application OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour en savoir plus, consultez la page Présentation de l'authentification.

DeleteOperation

rpc DeleteOperation(DeleteOperationRequest) renvoie (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 n'accepte pas cette méthode, il renvoie google.rpc.Code.UNIMPLEMENTED. Champs d'application des autorisations Requiert le champ d'application OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour en savoir plus, consultez la page Présentation de l'authentification.

GetOperation

rpc GetOperation(GetOperationRequest) renvoie (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 Requiert le champ d'application OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour en savoir plus, consultez la page Présentation de l'authentification.

ListOperations

rpc ListOperations(ListOperationsRequest) renvoie (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. REMARQUE : La liaison de 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 des raisons de rétrocompatibilité, le nom par défaut inclut l'ID de la collection des opérations. Toutefois, les utilisateurs qui le remplacent doivent s'assurer que la liaison de nom est la ressource parente, sans l'ID de la collection des opérations. Champs d'application des autorisations Requiert le champ d'application OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour en savoir plus, consultez la page Présentation de l'authentification.

WaitOperation

rpc WaitOperation(WaitOperationRequest) renvoie (Operation) Attend que l'opération de longue durée spécifiée soit terminée ou qu'elle ait atteint un délai d'expiration spécifié en renvoyant l'état le plus récent. 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 Requiert le champ d'application OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour en savoir plus, consultez la page Présentation de l'authentification.

CancelOperationRequest

Le message de la requête pour Operations.CancelOperation.

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

DeleteOperationRequest

Le message de la requête pour Operations.DeleteOperation.

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

GetOperationRequest

Le message de la requête pour Operations.GetOperation.

Champs
name	string Nom de ressource de l'opération.

ListOperationsRequest

Le message de la requête pour Operations.ListOperations.

Champs
name	string Le nom de la ressource parente de l'opération.
filter	string Une expression pour filtrer les résultats de la requête. operation_id - pour = ou !=. done - pour = ou !=. works_on - pour = ou !=. Exemples d'utilisation du filtre : done=true --> L'opération est terminée. worksOn = projects/my-project/locations/us-central1/datasets/5 --> L’opération est effectuée sur un ensemble de données portant l’ID 5. worksOn = projects/my-project/locations/us-central1/models/15 --> L'opération est effectuée sur un modèle portant l'ID 15.
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 au format operations/some/unique/name.
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 définie sur 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.
Valeur result du champ d'union. Le résultat de l'opération, qui peut être un message error ou response valide. Si done correspond à false, aucun message error ni response n'est défini. Si done correspond à true, exactement un message error ou response est défini. Le champ result ne peut être que l'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 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 un message standard Get/Create/Update, la réponse doit être la ressource. Pour les autres méthodes, la réponse doit comporter le type XxxResponse, où Xxx correspond au nom de la méthode d'origine. Par exemple, si le nom de la méthode d'origine est TakeSnapshot(), le type de la réponse supposée est TakeSnapshotResponse.

WaitOperationRequest

Le message de la 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.