Package ai.vectros.resources.compliance.requests

Class ErasureRequest.Builder

java.lang.Object

ai.vectros.resources.compliance.requests.ErasureRequest.Builder

All Implemented Interfaces:

ErasureRequest._FinalStage, ErasureRequest.SubjectTypeStage

Enclosing class:

ErasureRequest

public static final class ErasureRequest.Builder
extends Object
implements ErasureRequest.SubjectTypeStage, ErasureRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
ErasureRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
ErasureRequest.Builder	additionalProperty(String key, Object value)
ErasureRequest._FinalStage	auditDisposition(ErasureRequestAuditDisposition auditDisposition)	How to handle the subject's audit and version-history trail.
ErasureRequest._FinalStage	auditDisposition(Optional<ErasureRequestAuditDisposition> auditDisposition)	How to handle the subject's audit and version-history trail.
ErasureRequest	build()
ErasureRequest._FinalStage	contextScope(List<String> contextScope)	The contexts in which to erase the subject.
ErasureRequest._FinalStage	contextScope(Optional<List<String>> contextScope)	The contexts in which to erase the subject.
ErasureRequest._FinalStage	externalId(String externalId)	Your own externalId for the subject, as an alternative to subjectId.
ErasureRequest._FinalStage	externalId(Optional<String> externalId)	Your own externalId for the subject, as an alternative to subjectId.
ErasureRequest.Builder	from(ErasureRequest other)
ErasureRequest._FinalStage	subjectId(String subjectId)	The platform id of the subject to erase (the userId, clientId, or orgId returned when the subject was created).
ErasureRequest._FinalStage	subjectId(Optional<String> subjectId)	The platform id of the subject to erase (the userId, clientId, or orgId returned when the subject was created).
ErasureRequest._FinalStage	subjectType(@NotNull ErasureRequestSubjectType subjectType)	The kind of end-subject to erase: user, client, or org.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public ErasureRequest.Builder from(ErasureRequest other)

Specified by:

from in interface ErasureRequest.SubjectTypeStage

subjectType

public ErasureRequest._FinalStage subjectType(@NotNull
 @NotNull ErasureRequestSubjectType subjectType)

The kind of end-subject to erase: user, client, or org.

The kind of end-subject to erase: user, client, or org.

Specified by:

subjectType in interface ErasureRequest.SubjectTypeStage

Returns:

Reference to this so that method calls can be chained together.

auditDisposition

public ErasureRequest._FinalStage auditDisposition(ErasureRequestAuditDisposition auditDisposition)

How to handle the subject's audit and version-history trail. This governs only the audit data — the subject's records and documents are always erased regardless. retain-redacted (the default) keeps the compliance audit trail with sensitive data redacted; purge additionally hard-removes the audit history itself (subject to your legal obligations).

Specified by:

auditDisposition in interface ErasureRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

auditDisposition

public ErasureRequest._FinalStage auditDisposition(Optional<ErasureRequestAuditDisposition> auditDisposition)

How to handle the subject's audit and version-history trail. This governs only the audit data — the subject's records and documents are always erased regardless. retain-redacted (the default) keeps the compliance audit trail with sensitive data redacted; purge additionally hard-removes the audit history itself (subject to your legal obligations).

Specified by:

auditDisposition in interface ErasureRequest._FinalStage

contextScope

public ErasureRequest._FinalStage contextScope(List<String> contextScope)

The contexts in which to erase the subject. As the data controller, you declare the blast radius: each listed context is erased independently and reported separately on the certificate. Omit or leave empty to erase every context the subject has data in; those contexts are then enumerated and erased one at a time, never as a single account-wide sweep. Any context you do not list is left untouched, and managing that residual data is your responsibility.

Specified by:

contextScope in interface ErasureRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

contextScope

public ErasureRequest._FinalStage contextScope(Optional<List<String>> contextScope)

The contexts in which to erase the subject. As the data controller, you declare the blast radius: each listed context is erased independently and reported separately on the certificate. Omit or leave empty to erase every context the subject has data in; those contexts are then enumerated and erased one at a time, never as a single account-wide sweep. Any context you do not list is left untouched, and managing that residual data is your responsibility.

Specified by:

contextScope in interface ErasureRequest._FinalStage

externalId

public ErasureRequest._FinalStage externalId(String externalId)

Your own externalId for the subject, as an alternative to subjectId. Provide exactly one of subjectId or externalId.

Specified by:

externalId in interface ErasureRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

externalId

public ErasureRequest._FinalStage externalId(Optional<String> externalId)

Your own externalId for the subject, as an alternative to subjectId. Provide exactly one of subjectId or externalId.

Specified by:

externalId in interface ErasureRequest._FinalStage

subjectId

public ErasureRequest._FinalStage subjectId(String subjectId)

The platform id of the subject to erase (the userId, clientId, or orgId returned when the subject was created). Provide exactly one of subjectId or externalId.

Specified by:

subjectId in interface ErasureRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

subjectId

public ErasureRequest._FinalStage subjectId(Optional<String> subjectId)

The platform id of the subject to erase (the userId, clientId, or orgId returned when the subject was created). Provide exactly one of subjectId or externalId.

Specified by:

subjectId in interface ErasureRequest._FinalStage

build

public ErasureRequest build()

Specified by:

build in interface ErasureRequest._FinalStage

additionalProperty

public ErasureRequest.Builder additionalProperty(String key,
 Object value)

Specified by:

additionalProperty in interface ErasureRequest._FinalStage

additionalProperties

public ErasureRequest.Builder additionalProperties(Map<String,Object> additionalProperties)

Specified by:

additionalProperties in interface ErasureRequest._FinalStage