io.enterpriseai.resources.RetentionClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/RetentionClient.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 RetentionClient
Conservation. Durée de conservation des données du tenant, leur purge, l'effacement d'une personne concernée (article 17 du RGPD) et les gels juridiques.
Constructeur RetentionClient
RetentionClient(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. |
RetentionClient.createPolicy
JsonNode createPolicy(Object body)
Créer ou modifier une politique de conservation. Définit la politique de conservation d'un type de ressource, en remplaçant l'existante. Exige tenant_admin, security_officer ou data_steward. Un type de ressource inconnu ou une action autre que erase ou archive répond 400 invalid_request. La politique s'applique à la passe de conservation suivante. Écrit l'événement d'audit retention.policy.upsert. Répond 201 avec la politique.
Route : /v1/retention/policies (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Type de ressource, durée de vie et action de la politique. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Créer ou modifier une politique de conservation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
RetentionClient.createPolicy
JsonNode createPolicy(Object body, RequestOptions options)
Créer ou modifier une politique de conservation. Définit la politique de conservation d'un type de ressource, en remplaçant l'existante. Exige tenant_admin, security_officer ou data_steward. Un type de ressource inconnu ou une action autre que erase ou archive répond 400 invalid_request. La politique s'applique à la passe de conservation suivante. Écrit l'événement d'audit retention.policy.upsert. Répond 201 avec la politique.
Route : /v1/retention/policies (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Type de ressource, durée de vie et action de la politique. | |
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 ou modifier une politique de conservation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
RetentionClient.erase
JsonNode erase(Object body)
Effacer une personne concernée. Supprime les données détenues sur une personne, en une transaction. Exige tenant_admin, security_officer ou data_steward.
Route : /v1/retention/erase (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Personne, périmètre et raison de l'effacement. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Effacer une personne concernée ».
Erreurs levées : les erreurs typées du transport (Erreurs).
RetentionClient.erase
JsonNode erase(Object body, RequestOptions options)
Effacer une personne concernée. Supprime les données détenues sur une personne, en une transaction. Exige tenant_admin, security_officer ou data_steward.
Route : /v1/retention/erase (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Personne, périmètre et raison de l'effacement. | |
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 « Effacer une personne concernée ».
Erreurs levées : les erreurs typées du transport (Erreurs).
RetentionClient.legalHold
JsonNode legalHold(Object body)
Poser ou lever un gel juridique. Sans hold_id, pose un nouveau gel sur une personne (subject_id) ou sur une ressource (resource_type et resource_id) ; reason est obligatoire (400 invalid_request sinon). Avec hold_id, active ou lève ce gel selon active (404 not_found pour un gel inconnu).
Route : /v1/retention/legal-hold (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Nouveau gel, ou identifiant d'un gel à activer ou lever. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Poser ou lever un gel juridique ».
Erreurs levées : les erreurs typées du transport (Erreurs).
RetentionClient.legalHold
JsonNode legalHold(Object body, RequestOptions options)
Poser ou lever un gel juridique. Sans hold_id, pose un nouveau gel sur une personne (subject_id) ou sur une ressource (resource_type et resource_id) ; reason est obligatoire (400 invalid_request sinon). Avec hold_id, active ou lève ce gel selon active (404 not_found pour un gel inconnu).
Route : /v1/retention/legal-hold (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Nouveau gel, ou identifiant d'un gel à activer ou lever. | |
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 « Poser ou lever un gel juridique ».
Erreurs levées : les erreurs typées du transport (Erreurs).
RetentionClient.listPolicies
Page<JsonNode> listPolicies()
Lister les politiques de conservation. Renvoie les politiques de conservation du tenant triées par type de ressource dans items, et les gels juridiques actifs dans legal_holds. Ouvert à tout membre du tenant. next_cursor vaut toujours null.
Route : /v1/retention/policies (GET).
Cet élément ne prend aucun paramètre.
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les politiques de conservation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
RetentionClient.run
JsonNode run(Object body)
Lancer les politiques de conservation. Applique maintenant les politiques actives, à tous les types de ressources ou à ceux de resource_types. Les éléments de mémoire et les médias dont l'expiration propre est passée sont purgés même sans politique ; les transcriptions et enregistrements temps réel suivent la durée de conservation du consentement des participants. Les éléments sous gel juridique sont ignorés.
Route : /v1/retention/run (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Indicateur de simulation et types de ressources facultatifs. Un corps vide lance réellement toutes les politiques. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lancer les politiques de conservation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
RetentionClient.run
JsonNode run(Object body, RequestOptions options)
Lancer les politiques de conservation. Applique maintenant les politiques actives, à tous les types de ressources ou à ceux de resource_types. Les éléments de mémoire et les médias dont l'expiration propre est passée sont purgés même sans politique ; les transcriptions et enregistrements temps réel suivent la durée de conservation du consentement des participants. Les éléments sous gel juridique sont ignorés.
Route : /v1/retention/run (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Indicateur de simulation et types de ressources facultatifs. Un corps vide lance réellement toutes les politiques. | |
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 « Lancer les politiques de conservation ».
Erreurs levées : les erreurs typées du transport (Erreurs).