io.enterpriseai.resources.ContractsClient

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

Contrats et manifestes. Schémas JSON publiés (contrats) des documents de la plateforme, et manifestes déclaratifs qui créent ou mettent à jour des objets à partir d'un document, dans l'esprit de l'infrastructure as code.

Constructeur ContractsClient

ContractsClient(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.

ContractsClient.get

JsonNode get(String name)

Lire un contrat. Renvoie le schéma JSON du contrat tel qu'il est publié. Ouvert à tout appelant authentifié. Un nom inconnu répond 404 unknown_contract.

Route : /v1/contracts/{name} (GET).

Nom	Type	Défaut	Requis	Description
name	String		oui	Nom du contrat, par exemple agent-manifest.

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

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

ContractsClient.list

JsonNode list()

Lister les contrats. Liste les contrats publiés avec leur name, title, kind, type, file, l'id du schéma et sa description. Ouvert à tout appelant authentifié. next_cursor vaut toujours null.

Route : /v1/contracts (GET).

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

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

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

ContractsClient.validate

ValidationResult validate(String name, Object document)

Validation locale avec la copie embarquée de contracts/v1 (sans appel réseau).

Nom	Type	Défaut	Requis	Description
name	String		oui	Nom du contrat, par exemple tool-manifest ; un nom inconnu lève IllegalArgumentException.
document	Object		oui	Valeur à valider : un JsonNode, une Map ou un record converti en JSON.

Retour : ValidationResult. Un ValidationResult : résultat de la validation, avec le nom du contrat et les erreurs.

ContractsClient.validateManifest

ValidationResult validateManifest(Object manifest)

Validation locale d'un manifeste, le contrat est choisi d'après kind.

Nom	Type	Défaut	Requis	Description
manifest	Object		oui	Manifeste à valider ; son kind choisit le contrat, un genre inconnu donne un résultat invalide pour le contrat unknown.

Retour : ValidationResult. Un ValidationResult : résultat de la validation, avec le nom du contrat et les erreurs.

ContractsClient.validateRemote

JsonNode validateRemote(String name, Object body)

Valider un document avec un contrat. Valide le corps avec le contrat, formats compris, sans rien enregistrer. La réponse donne contract, valid et errors, chacune avec le path JSON de la valeur fautive et un message. Ouvert à tout appelant authentifié. Un contrat inconnu répond 404 unknown_contract.

Route : /v1/contracts/{name}/validate (POST).

Nom	Type	Défaut	Requis	Description
name	String		oui	Nom du contrat, par exemple agent-manifest.
body	Object		oui	Tout document JSON à valider.

Retour : JsonNode. Réponse JSON décodée de l'opération « Valider un document avec un contrat ».

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

ContractsClient.validateRemote

JsonNode validateRemote(String name, Object body, RequestOptions options)

Valider un document avec un contrat. Valide le corps avec le contrat, formats compris, sans rien enregistrer. La réponse donne contract, valid et errors, chacune avec le path JSON de la valeur fautive et un message. Ouvert à tout appelant authentifié. Un contrat inconnu répond 404 unknown_contract.

Route : /v1/contracts/{name}/validate (POST).

Nom	Type	Défaut	Requis	Description
name	String		oui	Nom du contrat, par exemple agent-manifest.
body	Object		oui	Tout document JSON à valider.
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 un document avec un contrat ».

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