client.go (package eai)
Source : sdks/go/client.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.
Modèle Client
Un Client peut être utilisé par plusieurs goroutines en même temps.
Ce modèle ne déclare aucun champ.
Client.BaseURL
BaseURL() string
BaseURL renvoie l'URL de base configurée.
Cet élément ne prend aucun paramètre.
Retour : string. URL de base du Control Plane donnée par WithBaseURL, sans barre oblique finale.
Client.Locale
Locale() string
Locale renvoie "en" ou "fr".
Cet élément ne prend aucun paramètre.
Retour : string. Langue des messages du client, en ou fr.
Client.Tenant
Tenant() string
Tenant renvoie le slug du tenant configuré.
Cet élément ne prend aucun paramètre.
Retour : string. Slug du tenant donné par WithTenant, vide s'il n'a pas été fourni.
Alias de type Option
Option configure un Client.
Définition : func(*Client) error.
Fonctions
WithBaseURL
WithBaseURL(u string) Option
WithBaseURL définit l'URL du Control Plane (sans /v1). Obligatoire.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
u | string | oui | URL du Control Plane sans /v1 ; les barres obliques finales sont retirées. |
Retour : Option. Une Option à passer à NewClient.
WithAPIKey
WithAPIKey(k string) Option
WithAPIKey définit la clé d'API du tenant envoyée dans l'en-tête X-API-Key.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
k | string | oui | Clé d'API du tenant, envoyée dans X-API-Key à chaque requête. |
Retour : Option. Une Option à passer à NewClient.
WithToken
WithToken(t string) Option
WithToken définit un jeton d'accès OIDC envoyé dans Authorization: Bearer.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
t | string | oui | Jeton d'accès OIDC, envoyé dans Authorization: Bearer <t>. |
Retour : Option. Une Option à passer à NewClient.
WithTenant
WithTenant(t string) Option
WithTenant définit le slug du tenant. Le serveur déduit le tenant de l'identifiant ; sans aucun identifiant, le slug est envoyé dans X-Dev-Tenant (mode développement, EAI_AUTH_DEV=1).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
t | string | oui | Slug du tenant, envoyé dans X-Dev-Tenant seulement si aucune clé d'API ni aucun jeton n'est défini. |
Retour : Option. Une Option à passer à NewClient.
WithProject
WithProject(p string) Option
WithProject définit X-Project.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
p | string | oui | Projet envoyé dans X-Project à chaque requête. |
Retour : Option. Une Option à passer à NewClient.
WithEnvironment
WithEnvironment(e string) Option
WithEnvironment définit X-Environment (dev, test, staging, prod).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
e | string | oui | Environnement envoyé dans X-Environment : dev, test, staging ou prod. |
Retour : Option. Une Option à passer à NewClient.
WithLocale
WithLocale(l string) Option
WithLocale choisit la langue des messages, "en" (par défaut) ou "fr" ; envoyée dans Accept-Language.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
l | string | oui | Code de langue ; toute valeur commençant par fr choisit le français, toute autre l'anglais. |
Retour : Option. Une Option à passer à NewClient.
WithRetries
WithRetries(n int) Option
WithRetries définit combien de fois les erreurs réseau et les réponses HTTP 408/429/502/503/504 sont relancées (2 par défaut).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
n | int | oui | Nombre de nouvelles tentatives, 0 ou plus ; une valeur négative fait échouer NewClient. |
Retour : Option. Une Option à passer à NewClient.
WithRetryBaseDelay
WithRetryBaseDelay(d time.Duration) Option
WithRetryBaseDelay définit le premier délai d'attente, doublé à chaque tentative ; Retry-After l'emporte s'il est présent.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
d | time.Duration | oui | Délai avant la première nouvelle tentative (250 ms par défaut). |
Retour : Option. Une Option à passer à NewClient.
WithHTTPClient
WithHTTPClient(h *http.Client) Option
WithHTTPClient fournit un *http.Client personnalisé (délais, proxy, TLS, mTLS).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
h | *http.Client | oui | Client HTTP utilisé pour chaque requête à la place de celui par défaut (délai de 60 secondes). |
Retour : Option. Une Option à passer à NewClient.
WithHeader
WithHeader(name string, value string) Option
WithHeader ajoute un en-tête envoyé à chaque requête.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | string | oui | Nom de l'en-tête HTTP à envoyer à chaque requête. | |
value | string | oui | Valeur de l'en-tête ; un WithHeader ultérieur avec le même nom la remplace. |
Retour : Option. Une Option à passer à NewClient.
WithTraceparent
WithTraceparent(f func() string) Option
WithTraceparent fournit une fonction qui renvoie le traceparent W3C du span courant ; sinon un traceparent aléatoire est généré par requête (un WithCallTraceparent par appel l'emporte).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
f | func() string | oui | Fonction appelée à chaque requête, qui renvoie la valeur de l'en-tête W3C traceparent. |
Retour : Option. Une Option à passer à NewClient.
NewClient
NewClient(opts ...Option) (*Client, error)
NewClient construit un client.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
opts | ...Option | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (*Client, error). Le *Client configuré de l'API du Control Plane, ses services prêts. L'error est renseignée quand une option échoue, que l'URL de base manque ou que les réglages TLS sont invalides, nil en cas de succès.
Erreurs levées : error.