io.enterpriseai.resources.MetaClient
Source: sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/MetaClient.java. Back to the Java SDK reference index.
This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.
Class MetaClient
System endpoints: health, readiness, platform metadata and the current principal.
Constructor MetaClient
MetaClient(Transport transport)
Creates the client on the shared transport; EnterpriseAIClient builds it and exposes it through the accessor of the same name.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
transport | Transport | yes | Transport shared by the sub-clients of one client. |
MetaClient.get
JsonNode get()
Describe the Control Plane instance. Name, version and API version of the instance, supported locales and default locale, loaded domains, and the features enabled by the configuration: OIDC, API key, SPIFFE and development authentication, OpenBao, OpenFGA, OPA and LiteLLM (true when their address is set). No authentication required.
Route: /v1/meta (GET).
This element takes no parameter.
Returns: JsonNode. Decoded JSON answer of the operation "Describe the Control Plane instance".
Raises: the typed errors of the transport (Errors).
MetaClient.health
JsonNode health()
Check that the process is alive. Liveness probe: always answers 200 with status: ok and the version of the Control Plane while the process serves requests. It checks no dependency. No authentication, no rate limit.
Route: /healthz (GET).
This element takes no parameter.
Returns: JsonNode. Decoded JSON answer of the operation "Check that the process is alive".
Raises: the typed errors of the transport (Errors).
MetaClient.me
JsonNode me()
Read the current principal. Who the caller is: principal id, kind, tenant, clearance, project, environment, authentication method and display name, with its roles and scopes. When the principal belongs to a tenant, the tenant (id, slug, name, status, data residency) is returned too. Requires authentication (401 otherwise).
Route: /v1/me (GET).
This element takes no parameter.
Returns: JsonNode. Decoded JSON answer of the operation "Read the current principal".
Raises: the typed errors of the transport (Errors).
MetaClient.metrics
String metrics()
GET /metrics: Prometheus text format (not part of the OpenAPI schema).
This element takes no parameter.
Returns: String. The metrics in Prometheus text format, decoded as UTF-8.
MetaClient.ready
JsonNode ready()
Check that the instance is ready. Readiness probe: checks that the database answers and that the schema migrations were applied. Answers 200 ready when every check passes, else 503 not_ready, with the result of each check and a message in the language of the request. The Redis cache state is reported but never makes the instance not ready. No authentication, no rate limit.
Route: /readyz (GET).
This element takes no parameter.
Returns: JsonNode. Decoded JSON answer of the operation "Check that the instance is ready".
Raises: the typed errors of the transport (Errors).