io.enterpriseai.resources.QuotasClient

Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/QuotasClient.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 QuotasClient

FinOps. Gestion des coûts de l'usage de l'IA : grilles tarifaires, événements d'usage, estimations, quotas et réservations, répartition du coût des GPU, rapprochement de la facturation et alertes.

Constructeur QuotasClient

QuotasClient(Transport transport)

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

Nom	Type	Défaut	Requis	Description
transport	Transport		oui	Transport partagé par les sous-clients d'un même client.

QuotasClient.commit

JsonNode commit(String id, Object body)

Valider une réservation. Remplace le montant réservé par le montant mesuré sur chaque fenêtre de quota de la réservation et vérifie les seuils d'alerte. Une réservation close répond 409 reservation_closed ; une réservation inconnue 404 reservation_not_found. Audité. Demande finops, tenant_admin, agent ou developer, et un principal de tenant.

Route : /v1/quotas/{reservation_id}/commit (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) de la réservation renvoyé par POST /v1/quotas/reserve.
body	Object		oui	Coût et jetons mesurés de l'appel.

Retour : JsonNode. Réponse JSON décodée de l'opération « Valider une réservation ».

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

QuotasClient.commit

JsonNode commit(String id, Object body, RequestOptions options)

Valider une réservation. Remplace le montant réservé par le montant mesuré sur chaque fenêtre de quota de la réservation et vérifie les seuils d'alerte. Une réservation close répond 409 reservation_closed ; une réservation inconnue 404 reservation_not_found. Audité. Demande finops, tenant_admin, agent ou developer, et un principal de tenant.

Route : /v1/quotas/{reservation_id}/commit (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) de la réservation renvoyé par POST /v1/quotas/reserve.
body	Object		oui	Coût et jetons mesurés de l'appel.
options	RequestOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation).

Retour : JsonNode. Réponse JSON décodée de l'opération « Valider une réservation ».

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

QuotasClient.create

JsonNode create(Object body)

Créer un quota. Crée un quota du tenant et répond 201. Une limite de coût ou de jetons est obligatoire, et scope_value est obligatoire sauf si scope_type vaut tenant (422 validation_error). Sans devise, celle du tenant s'applique. Audité. Demande finops ou tenant_admin, et un principal de tenant.

Route : /v1/quotas (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	Le nouveau quota.

Retour : JsonNode. Réponse JSON décodée de l'opération « Créer un quota ».

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

QuotasClient.create

JsonNode create(Object body, RequestOptions options)

Créer un quota. Crée un quota du tenant et répond 201. Une limite de coût ou de jetons est obligatoire, et scope_value est obligatoire sauf si scope_type vaut tenant (422 validation_error). Sans devise, celle du tenant s'applique. Audité. Demande finops ou tenant_admin, et un principal de tenant.

Route : /v1/quotas (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	Le nouveau quota.
options	RequestOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation).

Retour : JsonNode. Réponse JSON décodée de l'opération « Créer un quota ».

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

QuotasClient.delete

void delete(String id)

Supprimer un quota. Supprime un quota du tenant et répond 204. Identifiant inconnu : 404 quota_not_found. Audité (finops.quota.delete). Demande finops ou tenant_admin.

Route : /v1/quotas/{quota_id} (DELETE).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) du quota.

Retour : void.

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

QuotasClient.list

Page<JsonNode> list()

Lister les quotas. Quotas du tenant par nom, y compris ceux reproduits depuis les projets LLM (llm-project:...). Une seule page. Demande un rôle de lecteur et un principal de tenant.

Route : /v1/quotas (GET).

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

Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les quotas ».

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

QuotasClient.release

JsonNode release(String id)

Libérer une réservation. Rend le montant réservé à chaque fenêtre de quota de la réservation sans rien consommer (l'appel a échoué ou n'a pas eu lieu). Une réservation close répond 409 reservation_closed ; une réservation inconnue 404 reservation_not_found. Audité. Demande finops, tenant_admin, agent ou developer, et un principal de tenant.

Route : /v1/quotas/{reservation_id}/release (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) de la réservation.

Retour : JsonNode. Réponse JSON décodée de l'opération « Libérer une réservation ».

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

QuotasClient.release

JsonNode release(String id, RequestOptions options)

Libérer une réservation. Rend le montant réservé à chaque fenêtre de quota de la réservation sans rien consommer (l'appel a échoué ou n'a pas eu lieu). Une réservation close répond 409 reservation_closed ; une réservation inconnue 404 reservation_not_found. Audité. Demande finops, tenant_admin, agent ou developer, et un principal de tenant.

Route : /v1/quotas/{reservation_id}/release (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) de la réservation.
options	RequestOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation).

Retour : JsonNode. Réponse JSON décodée de l'opération « Libérer une réservation ».

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

QuotasClient.replace

JsonNode replace(String id, Object body)

Remplacer un quota. Remplace tous les champs d'un quota (mêmes règles qu'à la création ; sans devise, la devise actuelle est conservée). Identifiant inconnu : 404 quota_not_found. Audité. Demande finops ou tenant_admin, et un principal de tenant.

Route : /v1/quotas/{quota_id} (PUT).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) du quota.
body	Object		oui	Le quota complet.

Retour : JsonNode. Réponse JSON décodée de l'opération « Remplacer un quota ».

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

QuotasClient.replace

JsonNode replace(String id, Object body, RequestOptions options)

Remplacer un quota. Remplace tous les champs d'un quota (mêmes règles qu'à la création ; sans devise, la devise actuelle est conservée). Identifiant inconnu : 404 quota_not_found. Audité. Demande finops ou tenant_admin, et un principal de tenant.

Route : /v1/quotas/{quota_id} (PUT).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) du quota.
body	Object		oui	Le quota complet.
options	RequestOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation).

Retour : JsonNode. Réponse JSON décodée de l'opération « Remplacer un quota ».

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

QuotasClient.reserve

Reservation reserve(Object request)

Réserver un coût et des jetons. Réserve un montant sur chaque quota actif correspondant à la portée (les quotas du tenant correspondent toujours ; un principal utilisateur ajoute sa propre portée utilisateur) et répond 201 avec la réservation, ses éléments par quota et fenêtre, les quotas souples dépassés et son échéance. Un quota strict qui serait dépassé répond 429 quota_exceeded avec Retry-After: 60, et rien n'est réservé. Les réservations expirées sont d'abord libérées. Audité. Demande finops, tenant_admin, agent ou developer, et un principal de tenant.

Route : /v1/quotas/reserve (POST).

Nom	Type	Défaut	Requis	Description
request	Object		oui	Montant, portée et durée de vie de la réservation.

Retour : Reservation. Réponse JSON décodée de l'opération « Réserver un coût et des jetons ».

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

QuotasClient.reserveRaw

JsonNode reserveRaw(Object body)

Réserver un coût et des jetons. Réserve un montant sur chaque quota actif correspondant à la portée (les quotas du tenant correspondent toujours ; un principal utilisateur ajoute sa propre portée utilisateur) et répond 201 avec la réservation, ses éléments par quota et fenêtre, les quotas souples dépassés et son échéance. Un quota strict qui serait dépassé répond 429 quota_exceeded avec Retry-After: 60, et rien n'est réservé. Les réservations expirées sont d'abord libérées. Audité. Demande finops, tenant_admin, agent ou developer, et un principal de tenant.

Route : /v1/quotas/reserve (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	Montant, portée et durée de vie de la réservation.

Retour : JsonNode. Réponse JSON décodée de l'opération « Réserver un coût et des jetons ».

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

QuotasClient.reserveRaw

JsonNode reserveRaw(Object body, RequestOptions options)

Réserver un coût et des jetons. Réserve un montant sur chaque quota actif correspondant à la portée (les quotas du tenant correspondent toujours ; un principal utilisateur ajoute sa propre portée utilisateur) et répond 201 avec la réservation, ses éléments par quota et fenêtre, les quotas souples dépassés et son échéance. Un quota strict qui serait dépassé répond 429 quota_exceeded avec Retry-After: 60, et rien n'est réservé. Les réservations expirées sont d'abord libérées. Audité. Demande finops, tenant_admin, agent ou developer, et un principal de tenant.

Route : /v1/quotas/reserve (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	Montant, portée et durée de vie de la réservation.
options	RequestOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation).

Retour : JsonNode. Réponse JSON décodée de l'opération « Réserver un coût et des jetons ».

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

QuotasClient.usage

JsonNode usage()

Lire la consommation des quotas. Chaque quota du tenant avec sa fenêtre courante et le coût et les jetons consommés et réservés dans celle-ci. Les quotas par exécution demandent run pour trouver leur fenêtre. Demande un rôle de lecteur et un principal de tenant.

Route : /v1/quotas/usage (GET).

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

Retour : JsonNode. Réponse JSON décodée de l'opération « Lire la consommation des quotas ».

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

QuotasClient.usage

JsonNode usage(Map<String, ?> query)

Lire la consommation des quotas. Chaque quota du tenant avec sa fenêtre courante et le coût et les jetons consommés et réservés dans celle-ci. Les quotas par exécution demandent run pour trouver leur fenêtre. Demande un rôle de lecteur et un principal de tenant.

Route : /v1/quotas/usage (GET).

Nom	Type	Défaut	Requis	Description
query	Map<String, ?>		oui	Paramètres de la chaîne de requête de la route.

Retour : JsonNode. Réponse JSON décodée de l'opération « Lire la consommation des quotas ».

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