errors.go (package eai)
Source : sdks/go/errors.go. Retour à l'index de la référence du SDK Go.
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 APIError
APIError est l'enveloppe d'erreur {"error": {code, message, message_i18n, details, request_id}} renvoyée avec HTTP 4xx/5xx, ainsi que les erreurs réseau (Code "network_error", Status 0).
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
Status | int | oui | Statut HTTP de la réponse, 0 pour une erreur réseau. |
Code | string | oui | Code machine de l'erreur (policy_denied, not_found...) ; déduit du statut HTTP quand le corps n'en donne pas, network_error pour une panne réseau. |
Message | string | oui | Message dans la langue du client : d'abord message_i18n, puis le catalogue du SDK ou le message du serveur. |
MessageI18n | map[string]string | oui | La table message_i18n de l'enveloppe, un message par code de langue. |
Details | map[string]any | oui | L'objet details de l'enveloppe, secrets masqués, jamais nil. |
RequestID | string | oui | Identifiant de la requête tiré de l'enveloppe, ou de l'en-tête de la réponse quand le corps n'en donne pas. |
RetryAfter | time.Duration | oui | RetryAfter est renseigné quand le serveur a envoyé Retry-After (HasRetryAfter à true). |
HasRetryAfter | bool | oui | true quand le serveur a envoyé un en-tête Retry-After, RetryAfter porte alors sa valeur. |
APIError.ApprovalID
ApprovalID() string
ApprovalID renvoie details.approval_id d'une erreur approval_required.
Cet élément ne prend aucun paramètre.
Retour : string. La chaîne approval_id de Details, vide si elle est absente.
APIError.Error
Error() string
Error met en forme l'erreur en eai: <code> (HTTP <status>): <message>, sans la partie HTTP pour une erreur réseau.
Cet élément ne prend aucun paramètre.
Retour : string. Le texte de l'erreur avec le code, le statut et le message.
APIError.Is
Is(target error) bool
Is reconnaît les sentinelles Err* par leur code machine (errors.Is(err, eai.ErrPolicyDenied)).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
target | error | oui | Erreur à comparer, reconnue seulement si c'est l'une des sentinelles Err*. |
Retour : bool. true quand le code correspond à la sentinelle ; ErrQuotaExceeded, ErrNotFound et ErrAuth reconnaissent aussi des codes et statuts HTTP voisins.
APIError.Unwrap
Unwrap() error
Unwrap renvoie l'erreur réseau sous-jacente, s'il y en a une.
Cet élément ne prend aucun paramètre.
Retour : error. Erreur de l'appel (une erreur typée du SDK), nil en cas de succès.
Erreurs levées : error.
Fonctions
AsAPIError
AsAPIError(err error) (*APIError, bool)
AsAPIError extrait une *APIError.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
err | error | oui | Erreur renvoyée par le SDK, éventuellement enveloppée. |
Retour : (*APIError, bool). L'*APIError trouvée avec errors.As et true, ou nil et false.
IsPolicyDenied
IsPolicyDenied(err error) bool
IsPolicyDenied signale une erreur policy_denied.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
err | error | oui | Erreur à tester. |
Retour : bool. true quand err correspond à ErrPolicyDenied.
IsQuotaExceeded
IsQuotaExceeded(err error) bool
IsQuotaExceeded signale quota_exceeded ou budget_exceeded.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
err | error | oui | Erreur à tester. |
Retour : bool. true pour les codes quota_exceeded et budget_exceeded.
IsEffortNotSupported
IsEffortNotSupported(err error) bool
IsEffortNotSupported signale effort_not_supported.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
err | error | oui | Erreur à tester. |
Retour : bool. true quand err correspond à ErrEffortNotSupported.
IsContextOverflow
IsContextOverflow(err error) bool
IsContextOverflow signale context_overflow.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
err | error | oui | Erreur à tester. |
Retour : bool. true quand err correspond à ErrContextOverflow.
IsApprovalRequired
IsApprovalRequired(err error) bool
IsApprovalRequired signale approval_required.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
err | error | oui | Erreur à tester. |
Retour : bool. true quand err correspond à ErrApprovalRequired.
IsNotFound
IsNotFound(err error) bool
IsNotFound signale not_found ou HTTP 404.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
err | error | oui | Erreur à tester. |
Retour : bool. true pour le code not_found ou un statut HTTP 404.
IsAuth
IsAuth(err error) bool
IsAuth signale les erreurs d'authentification ou d'autorisation HTTP 401/403.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
err | error | oui | Erreur à tester. |
Retour : bool. true pour unauthenticated, forbidden, HTTP 401, ou HTTP 403 autre que policy_denied.