Aller au contenu principal

operations.go (package eai)

Source : sdks/go/operations.go. Retour à l'index de la référence du SDK Go.

remarque

Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.

Classe OperationsService​

Opérations. Opérations longues : un operation_id durable pour chaque création longue, pour la suivre et la relancer sans risque.

OperationsService.Get​

Get(ctx context.Context, operationID string, opts ...CallOption) (json.RawMessage, error)

Suivre une opération longue. L'opération (type, état pending ou accepted, méthode, chemin, statut HTTP, clé d'idempotence, ressource suivie, créateur et dates), sa réponse acceptée et l'état en direct de la ressource suivie. La ressource est lue avec les identifiants de l'appelant par la route de la ressource, donc l'autorisation de la ressource s'applique : si cette lecture échoue, result reste null et result_error.http_status donne le statut. status vaut pending pendant l'exécution de la requête, puis le status ou le state de la ressource. Demande un principal de tenant (403 tenant_required) ; une opération créée par quelqu'un d'autre répond 404 not_found sauf si l'appelant détient tenant_admin, platform_admin, auditor ou security_officer.

Route : /v1/operations/{operation_id} (GET).

NomTypeDéfautRequisDescription
ctxcontext.ContextouiContexte de l'appel : annulation et échéance.
operationIDstringouiIdentifiant de l'opération, tel que renvoyé dans l'en-tête Operation-Id.
opts...CallOptionnonOptions de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Suivre une opération longue ». L'error est une erreur typée du SDK, nil en cas de succès.

Erreurs levées : error, les erreurs typées du transport (Erreurs).