Package ai.vectros.resources.compliance.requests

Class ExportRequest.Builder

java.lang.Object

ai.vectros.resources.compliance.requests.ExportRequest.Builder

Enclosing class:

ExportRequest

public static final class ExportRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ExportRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
ExportRequest.Builder	additionalProperty(String key, Object value)
ExportRequest	build()
ExportRequest.Builder	contextScope(List<String> contextScope)
ExportRequest.Builder	contextScope(Optional<List<String>> contextScope)	The contexts to export.
ExportRequest.Builder	externalId(String externalId)
ExportRequest.Builder	externalId(Optional<String> externalId)	Your own externalId for the subject, as an alternative to subjectId (only when scope is subject).
ExportRequest.Builder	format(ExportRequestFormat format)
ExportRequest.Builder	format(Optional<ExportRequestFormat> format)	Serialization format of the export payload.
ExportRequest.Builder	from(ExportRequest other)
ExportRequest.Builder	includeAuditHistory(Boolean includeAuditHistory)
ExportRequest.Builder	includeAuditHistory(Optional<Boolean> includeAuditHistory)	Whether to also include the audit and version-history trail of the exported data, not just the current live rows.
ExportRequest.Builder	scope(ExportRequestScope scope)
ExportRequest.Builder	scope(Optional<ExportRequestScope> scope)	What to export.
ExportRequest.Builder	subjectId(String subjectId)
ExportRequest.Builder	subjectId(Optional<String> subjectId)	The platform id of the subject to export.
ExportRequest.Builder	subjectType(ExportRequestSubjectType subjectType)
ExportRequest.Builder	subjectType(Optional<ExportRequestSubjectType> subjectType)	The kind of subject to export: 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 ExportRequest.Builder from(ExportRequest other)

scope

public ExportRequest.Builder scope(Optional<ExportRequestScope> scope)

What to export. tenant (the default) exports all of your account's data across the requested contexts; subject exports a single end-subject's data (for example, to satisfy a one-person data-portability request). Additional scopes may be added in the future.

scope

public ExportRequest.Builder scope(ExportRequestScope scope)

subjectType

public ExportRequest.Builder subjectType(Optional<ExportRequestSubjectType> subjectType)

The kind of subject to export: user, client, or org. Required only when scope is subject.

subjectType

public ExportRequest.Builder subjectType(ExportRequestSubjectType subjectType)

subjectId

public ExportRequest.Builder subjectId(Optional<String> subjectId)

The platform id of the subject to export. Used only when scope is subject. Provide exactly one of subjectId or externalId.

subjectId

public ExportRequest.Builder subjectId(String subjectId)

externalId

public ExportRequest.Builder externalId(Optional<String> externalId)

Your own externalId for the subject, as an alternative to subjectId (only when scope is subject). Provide exactly one of subjectId or externalId.

externalId

public ExportRequest.Builder externalId(String externalId)

contextScope

public ExportRequest.Builder contextScope(Optional<List<String>> contextScope)

The contexts to export. Omit or leave empty to export all of your contexts. Each listed context is exported and reported separately in the manifest.

contextScope

public ExportRequest.Builder contextScope(List<String> contextScope)

format

public ExportRequest.Builder format(Optional<ExportRequestFormat> format)

Serialization format of the export payload. NDJSON (newline-delimited JSON, one row per line) is currently the only supported format; more may be added in the future. The manifest carries a formatVersion so you can parse the payload in a forward-compatible way.

format

public ExportRequest.Builder format(ExportRequestFormat format)

includeAuditHistory

public ExportRequest.Builder includeAuditHistory(Optional<Boolean> includeAuditHistory)

Whether to also include the audit and version-history trail of the exported data, not just the current live rows. Defaults to false (live data only). Set true to also export the retained version history. This governs only the audit data — the live records are always included.

includeAuditHistory

public ExportRequest.Builder includeAuditHistory(Boolean includeAuditHistory)

build

public ExportRequest build()

additionalProperty

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

additionalProperties

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