io.enterpriseai.manager.ManagerClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/manager/ManagerClient.java. Retour à l'index de la référence du SDK Java.
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 ManagerClient
Client de l'API du Platform Manager (navin-manager) : hôtes, clusters, services, HA, sauvegardes, restaurations et PRA.
ManagerGroups
Attributs :
| Nom | Type | Requis | Description |
|---|---|---|---|
ON_BEHALF_HEADER | String | oui | En-tête de délégation : l'utilisateur pour lequel agit un jeton de service. |
Constructeur ManagerClient
ManagerClient(Builder settings, Sender sender)
Constructeur privé : le client se crée avec ManagerClient.builder(), fromEnv() ou onBehalfOf.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
settings | Builder | oui | Réglages validés du builder, conservés pour onBehalfOf. | |
sender | Sender | oui | Émetteur HTTP interne qui porte le jeton, les en-têtes et le pool de connexions. |
ManagerClient.baseUrl
URI baseUrl()
URL du manager sans barre oblique finale.
Cet élément ne prend aucun paramètre.
Retour : URI. L'URL de base.
ManagerClient.call
JsonNode call(String operationIdOrAlias, Object body, Map<String, ?> query, String... pathParams)
Appelle une opération par son operationId (ou un alias), paramètres de chemin dans l'ordre du gabarit.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
operationIdOrAlias | String | oui | operationId ou alias group.method. | |
body | Object | oui | Corps de la requête, sérialisé en JSON. | |
query | Map<String, ?> | oui | Paramètres de la chaîne de requête de la route. | |
pathParams | String... | oui | Paramètres de chemin dans l'ordre du gabarit. |
Retour : JsonNode. La réponse analysée, un NullNode pour un corps vide.
ManagerClient.locale
Locale locale()
Langue des messages d'erreur.
Cet élément ne prend aucun paramètre.
Retour : Locale. La langue.
ManagerClient.onBehalfOf
ManagerClient onBehalfOf(String user)
Un client avec les mêmes réglages et le même pool de connexions, qui agit pour le compte de user.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
user | String | oui | Nom de l'utilisateur pour lequel agit le jeton de service (le jeton doit avoir la permission auth:delegate). |
Retour : ManagerClient. Le client délégué.
ManagerClient.page
Page<JsonNode> page(String operationIdOrAlias, Map<String, ?> query, String... pathParams)
Appelle une opération paginée par curseur ; la page renvoyée charge les suivantes.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
operationIdOrAlias | String | oui | operationId ou alias group.method d'une opération paginée. | |
query | Map<String, ?> | oui | Paramètres de la chaîne de requête de la route. | |
pathParams | String... | oui | Paramètres de chemin dans l'ordre du gabarit. |
Retour : Page<JsonNode>. La première page.
Erreurs levées : IllegalArgumentException.
ManagerClient.toString
String toString()
N'affiche jamais le jeton.
Cet élément ne prend aucun paramètre.
Retour : String. L'URL de base, le jeton masqué et l'utilisateur délégué.
Classe ManagerClient.Builder
Constructeur de la configuration du client.
Builder.baseUrl
Builder baseUrl(String v)
URL du Platform Manager, par exemple <manager-url> (https, ou http sur localhost).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | String | oui | L'URL. |
Retour : Builder. Ce même builder.
Builder.build
ManagerClient build()
Valide les réglages et construit le client.
Cet élément ne prend aucun paramètre.
Retour : ManagerClient. Le client.
Erreurs levées : IllegalArgumentException.
Builder.caBundle
Builder caBundle(Path pem)
Fichier PEM de certificats d'autorités supplémentaires (la PKI du manager) ; la vérification des certificats reste active.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
pem | Path | oui | Le bundle. |
Retour : Builder. Ce même builder.
Builder.connectTimeout
Builder connectTimeout(Duration v)
Délai d'établissement de la connexion (10 s par défaut).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | Duration | oui | Le délai. |
Retour : Builder. Ce même builder.
Builder.fromEnv
Builder fromEnv(Map<String, String> env)
Lit NM_MANAGER_URL, NM_MANAGER_TOKEN, NM_MANAGER_TOKEN_FILE, NM_MANAGER_CA_BUNDLE, NM_MANAGER_ON_BEHALF_OF et NM_MANAGER_LOCALE ; les valeurs vides sont ignorées. Les variables de la Control Plane (EAI_*) ne sont jamais lues.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
env | Map<String, String> | oui | Environnement, en général System.getenv(). |
Retour : Builder. Ce même builder.
Builder.header
Builder header(String name, String value)
En-tête supplémentaire envoyé sur chaque requête ; il ne peut remplacer ni Authorization ni l'en-tête de délégation.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom de l'en-tête. | |
value | String | oui | Valeur de l'en-tête. |
Retour : Builder. Ce même builder.
Builder.httpClient
Builder httpClient(HttpClient v)
java.net.http.HttpClient personnalisé (proxy, executor) ; il ne doit pas suivre les redirections.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | HttpClient | oui | Le client. |
Retour : Builder. Ce même builder.
Builder.locale
Builder locale(Locale v)
Langue des messages : Locale.ENGLISH (par défaut) ou Locale.FRENCH, envoyée dans Accept-Language.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | Locale | oui | La langue. |
Retour : Builder. Ce même builder.
Builder.onBehalfOf
Builder onBehalfOf(String user)
Utilisateur pour lequel agit le jeton de service, envoyé dans X-NM-On-Behalf-Of.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
user | String | oui | Le nom de l'utilisateur. |
Retour : Builder. Ce même builder.
Builder.retries
Builder retries(int v)
Nouvelles tentatives des GET, PUT et DELETE sur les erreurs réseau et les HTTP 408/429/502/503/504 (2 par défaut).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | int | oui | Le nombre de nouvelles tentatives. |
Retour : Builder. Ce même builder.
Builder.retryBaseDelay
Builder retryBaseDelay(Duration v)
Premier délai d'attente, doublé à chaque tentative ; Retry-After l'emporte quand il est présent.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | Duration | oui | Le délai. |
Retour : Builder. Ce même builder.
Builder.timeout
Builder timeout(Duration v)
Délai d'expiration par requête (30 s par défaut).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | Duration | oui | Le délai. |
Retour : Builder. Ce même builder.
Builder.toString
String toString()
N'affiche jamais le jeton.
Cet élément ne prend aucun paramètre.
Retour : String. Un résumé des réglages avec le jeton masqué.
Builder.token
Builder token(String v)
Jeton de l'API du manager nmt_<12 hex>_<secret>, envoyé dans Authorization: Bearer.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | String | oui | Le jeton. |
Retour : Builder. Ce même builder.
Builder.tokenFile
Builder tokenFile(Path v)
Fichier qui contient le jeton (mode 0600), lu par #build() quand aucun jeton n'est fixé.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | Path | oui | Le fichier du jeton. |
Retour : Builder. Ce même builder.
Builder.traceparent
Builder traceparent(Supplier<String> v)
Fournit le traceparent W3C du span courant ; sinon un traceparent aléatoire est généré.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | Supplier<String> | oui | Le fournisseur. |
Retour : Builder. Ce même builder.