io.enterpriseai.resources.ProjectsClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/ProjectsClient.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 ProjectsClient
Tenants et organisation. Les tenants, leur hiérarchie, les projets, les environnements et les membres.
Constructeur ProjectsClient
ProjectsClient(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. |
ProjectsClient.create
JsonNode create(Object body)
Créer un projet. Crée un projet dans le tenant de l'appelant. Exige tenant_admin.
Route : /v1/projects (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Identifiant court, nom, paramètres, environnements et rattachement du projet. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Créer un projet ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ProjectsClient.create
JsonNode create(Object body, RequestOptions options)
Créer un projet. Crée un projet dans le tenant de l'appelant. Exige tenant_admin.
Route : /v1/projects (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Identifiant court, nom, paramètres, environnements et rattachement du projet. | |
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 projet ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ProjectsClient.createEnvironment
JsonNode createEnvironment(String id, Object body)
Créer un environnement. Ajoute un environnement (dev, test, staging ou prod) au projet. Exige tenant_admin et la relation editor sur le projet. Un environnement qui existe déjà répond 409 conflict. Écrit l'événement d'audit environment.create.
Route : /v1/projects/{project_id}/environments (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) du projet. | |
body | Object | oui | Nom et paramètres de l'environnement. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Créer un environnement ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ProjectsClient.createEnvironment
JsonNode createEnvironment(String id, Object body, RequestOptions options)
Créer un environnement. Ajoute un environnement (dev, test, staging ou prod) au projet. Exige tenant_admin et la relation editor sur le projet. Un environnement qui existe déjà répond 409 conflict. Écrit l'événement d'audit environment.create.
Route : /v1/projects/{project_id}/environments (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) du projet. | |
body | Object | oui | Nom et paramètres de l'environnement. | |
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 environnement ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ProjectsClient.delete
void delete(String id)
Supprimer un projet. Supprime le projet et ses environnements. Exige tenant_admin et la relation owner sur le projet (403 relation_required). Des objets qui référencent encore le projet peuvent bloquer la suppression (409 conflict). Écrit l'événement d'audit project.delete. Répond 204.
Route : /v1/projects/{project_id} (DELETE).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) du projet. |
Retour : void.
Erreurs levées : les erreurs typées du transport (Erreurs).
ProjectsClient.get
JsonNode get(String id)
Lire un projet. Renvoie le projet avec ses environnements. Exige la relation viewer sur le projet (403 relation_required, audité). Répond 404 not_found pour un projet inconnu.
Route : /v1/projects/{project_id} (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) du projet. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lire un projet ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ProjectsClient.list
Page<JsonNode> list()
Lister les projets. Liste les projets du tenant triés par identifiant court, paginés, éventuellement filtrés par organisation ou unité métier. Ouvert à tout membre du tenant.
Route : /v1/projects (GET).
Cet élément ne prend aucun paramètre.
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les projets ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ProjectsClient.list
Page<JsonNode> list(Map<String, ?> query)
Lister les projets. Liste les projets du tenant triés par identifiant court, paginés, éventuellement filtrés par organisation ou unité métier. Ouvert à tout membre du tenant.
Route : /v1/projects (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
query | Map<String, ?> | oui | Paramètres de la chaîne de requête de la route. |
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les projets ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ProjectsClient.listEnvironments
Page<JsonNode> listEnvironments(String id)
Lister les environnements d'un projet. Liste les environnements du projet, triés par nom. Exige la relation viewer sur le projet. Non paginé : next_cursor vaut toujours null.
Route : /v1/projects/{project_id}/environments (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) du projet. |
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les environnements d'un projet ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ProjectsClient.update
JsonNode update(String id, Object body)
Modifier un projet. Modifie le nom, la description, les paramètres, les métadonnées ou le rattachement d'un projet. Envoyer organization_id ou business_unit_id à null détache le projet. L'unité doit appartenir à l'organisation (422 invalid_hierarchy). Exige tenant_admin et la relation editor sur le projet. Envoyez expected_version pour détecter une modification concurrente (409 version_conflict). Écrit l'événement d'audit project.update.
Route : /v1/projects/{project_id} (PATCH).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) du projet. | |
body | Object | oui | Champs à modifier ; les champs omis gardent leur valeur. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Modifier un projet ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ProjectsClient.update
JsonNode update(String id, Object body, RequestOptions options)
Modifier un projet. Modifie le nom, la description, les paramètres, les métadonnées ou le rattachement d'un projet. Envoyer organization_id ou business_unit_id à null détache le projet. L'unité doit appartenir à l'organisation (422 invalid_hierarchy). Exige tenant_admin et la relation editor sur le projet. Envoyez expected_version pour détecter une modification concurrente (409 version_conflict). Écrit l'événement d'audit project.update.
Route : /v1/projects/{project_id} (PATCH).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) du projet. | |
body | Object | oui | Champs à modifier ; les champs omis gardent leur valeur. | |
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 « Modifier un projet ».
Erreurs levées : les erreurs typées du transport (Erreurs).