transport.go (package eai)
Source : sdks/go/transport.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.
Alias de type CallOption
CallOption personnalise un appel.
Définition : func(*callConfig).
Modèle Response
Response est une réponse JSON accompagnée de ses en-têtes.
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
Status | int | oui | Code de statut HTTP de la réponse. |
Header | http.Header | oui | En-tête portant la clé pour api_key. X-API-Key par défaut. |
Body | json.RawMessage | oui | Corps JSON brut, null quand la réponse était vide. |
Fonctions
WithQuery
WithQuery(q map[string]string) CallOption
WithQuery ajoute des paramètres de requête (filtres, limit, cursor, group_by...).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
q | map[string]string | oui | Paramètres de requête par nom ; chacun remplace une valeur précédente du même nom. |
Retour : CallOption. Une CallOption : elle personnalise un appel.
WithLimit
WithLimit(n int) CallOption
WithLimit définit ?limit= pour les listes paginées.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
n | int | oui | Taille de page envoyée dans le paramètre de requête limit. |
Retour : CallOption. Une CallOption : elle personnalise un appel.
WithCursor
WithCursor(cur string) CallOption
WithCursor définit ?cursor= pour les listes paginées.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
cur | string | oui | Curseur de la page à lire, le next_cursor de la page précédente. |
Retour : CallOption. Une CallOption : elle personnalise un appel.
WithIdempotencyKey
WithIdempotencyKey(k string) CallOption
WithIdempotencyKey définit l'Idempotency-Key d'un POST (sinon une clé est générée et gardée d'une tentative à l'autre).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
k | string | oui | Clé d'idempotence envoyée dans Idempotency-Key sur un POST. |
Retour : CallOption. Une CallOption : elle personnalise un appel.
WithCallTraceparent
WithCallTraceparent(tp string) CallOption
WithCallTraceparent définit le traceparent W3C de cet appel.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
tp | string | oui | Valeur W3C traceparent ; elle l'emporte sur WithTraceparent et sur la valeur générée. |
Retour : CallOption. Une CallOption : elle personnalise un appel.
WithCallHeader
WithCallHeader(name string, value string) CallOption
WithCallHeader définit un en-tête pour cet appel seulement (par exemple pour transmettre les identifiants de l'appelant).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | string | oui | Nom de l'en-tête ; il remplace un en-tête du client portant le même nom. | |
value | string | oui | Valeur de l'en-tête. |
Retour : CallOption. Une CallOption : elle personnalise un appel.
NewTraceparent
NewTraceparent() string
NewTraceparent renvoie un traceparent W3C aléatoire "00-<trace id>--01".
Cet élément ne prend aucun paramètre.
Retour : string. Une valeur traceparent avec un identifiant de trace aléatoire de 32 caractères hexadécimaux et un identifiant de span de 16.
NewRequestID
NewRequestID() string
NewRequestID renvoie un identifiant de requête aléatoire.
Cet élément ne prend aucun paramètre.
Retour : string. 32 caractères hexadécimaux aléatoires.
ExpandPath
ExpandPath(tpl string, params ...string) (string, error)
ExpandPath remplit les emplacements {name} dans l'ordre ; {path} garde ses barres obliques.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
tpl | string | oui | Gabarit de chemin comme /v1/runs/{id}, ses emplacements remplis par les paramètres suivants dans l'ordre. | |
params | ...string | non | Champs supplémentaires fusionnés dans la requête. |
Retour : (string, error). Le chemin avec les valeurs échappées pour l'URL ; l'error est renseignée quand un paramètre manque ou est vide.
Erreurs levées : error.
ParseRetryAfter
ParseRetryAfter(v string) (time.Duration, bool)
ParseRetryAfter lit Retry-After en secondes ou en date HTTP ; ok vaut false s'il est absent ou invalide.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | string | oui | Valeur de l'en-tête Retry-After. |
Retour : (time.Duration, bool). Le délai à attendre (jamais négatif) et true, ou 0 et false quand la valeur est vide ou illisible.
Decode
Decode(raw json.RawMessage) (T, error)
Decode décode une réponse JSON brute en T.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
raw | json.RawMessage | oui | Renvoie une ApiResponse (données, statut, en-têtes) au lieu du corps décodé. |
Retour : (T, error). La valeur de type T et l'erreur de json.Unmarshal, nil en cas de succès.
Erreurs levées : error.