Aller au contenu principal

io.enterpriseai.resources.MetaClient

Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/MetaClient.java. Retour à l'index de la référence du SDK Java.

remarque

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 MetaClient​

Système. Points techniques du Control Plane : sondes de vie et de disponibilité, description de l'instance, identité de l'appelant, catalogue des briques de la plateforme et feuille de route du produit.

Constructeur MetaClient​

MetaClient(Transport transport)

Crée le client sur le transport partagé ; EnterpriseAIClient le construit, on y accède par l'accesseur du même nom.

NomTypeDéfautRequisDescription
transportTransportouiTransport partagé par les sous-clients d'un même client.

MetaClient.get​

JsonNode get()

Décrire l'instance du Control Plane. Nom, version et version d'API de l'instance, langues prises en charge et langue par défaut, domaines chargés, et fonctions activées par la configuration : authentification OIDC, par clé d'API, SPIFFE et de développement, OpenBao, OpenFGA, OPA et LiteLLM (vrai quand leur adresse est renseignée). Sans authentification.

Route : /v1/meta (GET).

Cet élément ne prend aucun paramètre.

Retour : JsonNode. Réponse JSON décodée de l'opération « Décrire l'instance du Control Plane ».

Erreurs levées : les erreurs typées du transport (Erreurs).

MetaClient.health​

JsonNode health()

Vérifier que le processus est vivant. Sonde de vie : répond toujours 200 avec status: ok et la version du Control Plane tant que le processus sert des requêtes. Elle ne vérifie aucune dépendance. Sans authentification ni limitation de débit.

Route : /healthz (GET).

Cet élément ne prend aucun paramètre.

Retour : JsonNode. Réponse JSON décodée de l'opération « Vérifier que le processus est vivant ».

Erreurs levées : les erreurs typées du transport (Erreurs).

MetaClient.me​

JsonNode me()

Lire le principal courant. Qui est l'appelant : identifiant du principal, type, tenant, habilitation, projet, environnement, méthode d'authentification et nom affiché, avec ses rôles et ses scopes. Si le principal appartient à un tenant, le tenant (identifiant, slug, nom, statut, résidence des données) est aussi renvoyé. Demande une authentification (401 sinon).

Route : /v1/me (GET).

Cet élément ne prend aucun paramètre.

Retour : JsonNode. Réponse JSON décodée de l'opération « Lire le principal courant ».

Erreurs levées : les erreurs typées du transport (Erreurs).

MetaClient.metrics​

String metrics()

GET /metrics : format texte Prometheus (hors du schéma OpenAPI).

Cet élément ne prend aucun paramètre.

Retour : String. Les métriques au format texte Prometheus, décodées en UTF-8.

MetaClient.ready​

JsonNode ready()

Vérifier que l'instance est prête. Sonde de disponibilité : vérifie que la base de données répond et que les migrations du schéma ont été appliquées. Répond 200 ready quand chaque contrôle réussit, sinon 503 not_ready, avec le résultat de chaque contrôle et un message dans la langue de la requête. L'état du cache Redis est indiqué mais ne rend jamais l'instance indisponible. Sans authentification ni limitation de débit.

Route : /readyz (GET).

Cet élément ne prend aucun paramètre.

Retour : JsonNode. Réponse JSON décodée de l'opération « Vérifier que l'instance est prête ».

Erreurs levées : les erreurs typées du transport (Erreurs).