Class ExportRequestResponse.Builder
- Enclosing class:
ExportRequestResponse
-
Method Summary
Modifier and TypeMethodDescriptionadditionalProperties(Map<String, Object> additionalProperties) additionalProperty(String key, Object value) build()completedAt(String completedAt) completedAt(Optional<String> completedAt) When the export finished, as an ISO-8601 UTC timestamp.When the job was accepted, as an ISO-8601 UTC timestamp.downloadUrl(String downloadUrl) downloadUrl(Optional<String> downloadUrl) Short-lived presigned URL for downloading the serialized export payload.When the presigned download URL expires, as an ISO-8601 UTC timestamp.exportJobId(String exportJobId) exportJobId(Optional<String> exportJobId) Opaque identifier for the export job.failureReason(String failureReason) failureReason(Optional<String> failureReason) Reason the export failed, suitable for display or programmatic handling.from(ExportRequestResponse other) manifest(ExportManifest manifest) manifest(Optional<ExportManifest> manifest) scope(ExportRequestResponseScope scope) scope(Optional<ExportRequestResponseScope> scope) Echoes the scope you requested:tenantfor a full export of your account, orsubjectfor a single end-subject's data.status(ExportRequestResponseStatus status) status(Optional<ExportRequestResponseStatus> status) Current status of the job.For asubject-scoped export, the resolved platform id of the exported subject (echoed back).subjectType(ExportRequestResponseSubjectType subjectType) subjectType(Optional<ExportRequestResponseSubjectType> subjectType) For asubject-scoped export, the kind of subject that was exported (echoed back).
-
Method Details
-
from
-
exportJobId
Opaque identifier for the export job. Pass this to
GET /v1/admin/export/{id}to poll for status and, once complete, the download URL. -
exportJobId
-
status
Current status of the job.
acceptedimmediately after submission, thenprocessingwhile the export runs, then eithercompleted(the download URL and manifest are populated) orfailed(seefailureReason). -
status
-
scope
Echoes the scope you requested:
tenantfor a full export of your account, orsubjectfor a single end-subject's data. -
scope
-
subjectType
public ExportRequestResponse.Builder subjectType(Optional<ExportRequestResponseSubjectType> subjectType) For a
subject-scoped export, the kind of subject that was exported (echoed back). Null for atenant-scoped export. -
subjectType
-
subjectId
For a
subject-scoped export, the resolved platform id of the exported subject (echoed back). Null for atenant-scoped export. -
subjectId
-
createdAt
When the job was accepted, as an ISO-8601 UTC timestamp.
-
createdAt
-
completedAt
When the export finished, as an ISO-8601 UTC timestamp. Null until
statusiscompleted. -
completedAt
-
downloadUrl
Short-lived presigned URL for downloading the serialized export payload. Present once
statusiscompleted; null while the job is accepted or processing. Treat it as a secret — anyone with the URL can download the data until it expires. -
downloadUrl
-
expiresAt
When the presigned download URL expires, as an ISO-8601 UTC timestamp. Poll the job again after this time to obtain a fresh URL. Null until
statusiscompleted. -
expiresAt
-
failureReason
Reason the export failed, suitable for display or programmatic handling. Present only when
statusisfailed; null otherwise. -
failureReason
-
manifest
-
manifest
-
build
-
additionalProperty
-
additionalProperties
-