Package ai.vectros.resources.compliance.requests

Class ExportRequest

java.lang.Object
ai.vectros.resources.compliance.requests.ExportRequest
public final class ExportRequest extends Object

  • Method Details

    • getScope

      public Optional<ExportRequestScope> getScope()
      Returns:
      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.

    • getSubjectType

      public Optional<ExportRequestSubjectType> getSubjectType()
      Returns:
      The kind of subject to export: user, client, or org. Required only when scope is subject.

    • getSubjectId

      public Optional<String> getSubjectId()
      Returns:
      The platform id of the subject to export. Used only when scope is subject. Provide exactly one of subjectId or externalId.

    • getExternalId

      public Optional<String> getExternalId()
      Returns:
      Your own externalId for the subject, as an alternative to subjectId (only when scope is subject). Provide exactly one of subjectId or externalId.

    • getContextScope

      public Optional<List<String>> getContextScope()
      Returns:
      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.

    • getFormat

      public Optional<ExportRequestFormat> getFormat()
      Returns:
      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.

    • getIncludeAuditHistory

      public Optional<Boolean> getIncludeAuditHistory()
      Returns:
      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.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static ExportRequest.Builder builder()