manager/client.go (package manager)
Source : sdks/go/manager/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.
Alias de type Option
Option configure New.
Définition : func(*settings) error.
Classe Client
Client appelle l'API du Platform Manager ; ses champs sont les groupes d'opérations générés.
Client.Call
Call(ctx context.Context, operationID string, body any, opts []eai.CallOption, params ...string) (json.RawMessage, error)
Call effectue un appel JSON et renvoie le corps JSON brut ("null" pour un corps vide) ; sur le client du Platform Manager, l'opération de manager-openapi.json est désignée par son operationId (paramètres de chemin dans l'ordre du gabarit).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
operationID | string | oui | operationId de manager-openapi.json, une clé de Operations ; un identifiant inconnu renvoie une erreur. | |
body | any | oui | Corps de la requête, sérialisé en JSON. | |
opts | []eai.CallOption | oui | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). | |
params | ...string | non | Champs supplémentaires fusionnés dans la requête. |
Retour : (json.RawMessage, error). Corps JSON brut de la réponse, null pour un corps vide. L'error est une *eai.APIError typée, nil en cas de succès.
Erreurs levées : error.
Client.Call
Call(ctx context.Context, method string, tpl string, body any, opts []CallOption, params ...string) (json.RawMessage, error)
Call effectue un appel JSON et renvoie le corps JSON brut ("null" pour un corps vide) ; sur le client du Platform Manager, l'opération de manager-openapi.json est désignée par son operationId (paramètres de chemin dans l'ordre du gabarit).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
method | string | oui | Méthode HTTP de l'appel, par exemple GET ou POST. | |
tpl | string | oui | Gabarit de chemin comme /v1/runs/{id}, ses emplacements remplis par les paramètres de chemin dans l'ordre. | |
body | any | oui | Corps de la requête, sérialisé en JSON. | |
opts | []CallOption | oui | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). | |
params | ...string | non | Champs supplémentaires fusionnés dans la requête. |
Retour : (json.RawMessage, error). Corps JSON brut de la réponse, null pour un corps vide. L'error est une *eai.APIError typée, nil en cas de succès.
Erreurs levées : error.
Client.Do
Do(ctx context.Context, method string, tpl string, body any, accept string, opts []CallOption, params ...string) (*http.Response, error)
Do envoie une requête avec les nouvelles tentatives et renvoie la réponse réussie (l'appelant ferme le corps). body peut être nil, []byte (envoyé tel quel) ou toute valeur sérialisable en JSON.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
method | string | oui | Méthode HTTP ; un POST reçoit une Idempotency-Key gardée d'une tentative à l'autre. | |
tpl | string | oui | Gabarit de chemin comme /v1/runs/{id}, ses emplacements remplis par les paramètres de chemin dans l'ordre. | |
body | any | oui | Corps de la requête, sérialisé en JSON. | |
accept | string | oui | Valeur de l'en-tête Accept, par exemple application/json ou text/event-stream. | |
opts | []CallOption | oui | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). | |
params | ...string | non | Champs supplémentaires fusionnés dans la requête. |
Retour : (*http.Response, error). La *http.Response d'un statut inférieur à 400, son corps encore ouvert. L'error est une *APIError typée pour une erreur HTTP ou une panne réseau, nil en cas de succès.
Erreurs levées : error.
Client.Exchange
Exchange(ctx context.Context, method string, tpl string, body any, opts []CallOption, params ...string) (*Response, error)
Exchange effectue un appel JSON et renvoie le statut, les en-têtes et le corps.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
method | string | oui | Méthode HTTP de l'appel, par exemple GET ou POST. | |
tpl | string | oui | Gabarit de chemin comme /v1/runs/{id}, ses emplacements remplis par les paramètres de chemin dans l'ordre. | |
body | any | oui | Corps de la requête, sérialisé en JSON. | |
opts | []CallOption | oui | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). | |
params | ...string | non | Champs supplémentaires fusionnés dans la requête. |
Retour : (*Response, error). Une Response : une réponse JSON accompagnée de ses en-têtes. L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error.
Client.GoString
GoString() string
GoString empêche %#v d'afficher les secrets.
Cet élément ne prend aucun paramètre.
Retour : string. Le même texte que String, secrets masqués.
Client.Headers
Headers(opts ...CallOption) http.Header
Headers renvoie les en-têtes envoyés à chaque requête (authentification, tenancy, langue, trace) pour cet appel.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
opts | ...CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : http.Header. Une copie des en-têtes, avec traceparent et les en-têtes propres à l'appel appliqués.
Client.OnBehalfOf
OnBehalfOf(user string) (*Client, error)
OnBehalfOf renvoie un client avec les mêmes réglages qui agit pour user.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
user | string | oui | Utilisateur pour lequel agit le nouveau client, envoyé dans X-NM-On-Behalf-Of ; le jeton doit avoir la permission auth:delegate. |
Retour : (*Client, error). Un Client : il appelle l'API du Platform Manager ; ses champs sont les groupes d'opérations générés. L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error.
Client.String
String() string
String n'affiche jamais le jeton (ni, pour le client eai, la clé d'API).
Cet élément ne prend aucun paramètre.
Retour : string. Une description avec l'URL de base et, pour le client du manager, l'utilisateur représenté ; les secrets ne sont jamais affichés.
Client.String
String() string
String n'affiche jamais le jeton (ni, pour le client eai, la clé d'API).
Cet élément ne prend aucun paramètre.
Retour : string. Une description avec l'URL de base et, pour le client du manager, l'utilisateur représenté ; les secrets ne sont jamais affichés.
Fonctions
WithBaseURL
WithBaseURL(u string) Option
WithBaseURL définit l'URL du manager (https, ou http sur localhost).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
u | string | oui | URL du Platform Manager ; New refuse http sauf pour localhost et 127.0.0.1. |
Retour : Option. Une Option : elle configure New.
WithToken
WithToken(t string) Option
WithToken définit le jeton d'API du manager nmt_<12 hex>_<secret>.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
t | string | oui | Jeton d'API du manager nmt_<12 hex>_<secret> ; un autre format fait échouer New. |
Retour : Option. Une Option : elle configure New.
WithOnBehalfOf
WithOnBehalfOf(user string) Option
WithOnBehalfOf envoie X-NM-On-Behalf-Of à chaque appel.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
user | string | oui | Utilisateur pour lequel agit un jeton de service ; le jeton doit avoir la permission auth:delegate. |
Retour : Option. Une Option : elle configure New.
WithLocale
WithLocale(l string) Option
WithLocale choisit la langue des messages d'erreur ("en" ou "fr").
| 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 : elle configure New.
WithCABundle
WithCABundle(pem []byte) Option
WithCABundle fait confiance à l'autorité de certification du manager encodée en PEM, en plus du magasin du système.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
pem | []byte | oui | Autorité de certification du manager encodée en PEM ; vide, seul le magasin du système est utilisé. |
Retour : Option. Une Option : elle configure New.
WithHTTPClient
WithHTTPClient(h *http.Client) Option
WithHTTPClient fournit le *http.Client (tests, proxys, mTLS).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
h | *http.Client | oui | Client HTTP utilisé par le transport, à la place de celui par défaut du paquet eai. |
Retour : Option. Une Option : elle configure New.
WithRetries
WithRetries(n int) Option
WithRetries définit le nombre de nouvelles tentatives des appels GET, PUT et DELETE (2 par défaut).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
n | int | oui | Nombre de nouvelles tentatives des GET, PUT et DELETE, 0 ou plus ; les autres méthodes ne sont jamais relancées. |
Retour : Option. Une Option : elle configure New.
WithRetryBaseDelay
WithRetryBaseDelay(d time.Duration) Option
WithRetryBaseDelay définit le premier délai d'attente des appels relancés.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
d | time.Duration | oui | Délai avant la première nouvelle tentative (250 ms par défaut), doublé à chaque tentative. |
Retour : Option. Une Option : elle configure New.
WithHeader
WithHeader(name string, value string) Option
WithHeader ajoute un en-tête envoyé à chaque appel.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | string | oui | Nom de l'en-tête HTTP à envoyer à chaque appel. | |
value | string | oui | Valeur de l'en-tête ; un WithHeader ultérieur avec le même nom la remplace. |
Retour : Option. Une Option : elle configure New.
New
New(opts ...Option) (*Client, error)
New construit un client du manager.
| 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). Un Client : il appelle l'API du Platform Manager ; ses champs sont les groupes d'opérations générés. L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error.