Class ExportRequestResponse

java.lang.Object
ai.vectros.types.ExportRequestResponse

public final class ExportRequestResponse extends Object
  • Method Details

    • getExportJobId

      public Optional<String> getExportJobId()
      Returns:
      Opaque identifier for the export job. Pass this to GET /v1/admin/export/{id} to poll for status and, once complete, the download URL.
    • getStatus

      Returns:
      Current status of the job. accepted immediately after submission, then processing while the export runs, then either completed (the download URL and manifest are populated) or failed (see failureReason).
    • getScope

      Returns:
      Echoes the scope you requested: tenant for a full export of your account, or subject for a single end-subject's data.
    • getSubjectType

      public Optional<String> getSubjectType()
      Returns:
      For a subject-scoped export, the kind of subject that was exported — user, or an ownership namespace such as org or client (echoed back). Null for a tenant-scoped export.
    • getSubjectId

      public Optional<String> getSubjectId()
      Returns:
      For a subject-scoped export, the resolved platform id of the exported subject (echoed back). Null for a tenant-scoped export.
    • getCreatedAt

      public Optional<String> getCreatedAt()
      Returns:
      When the job was accepted, as an ISO-8601 UTC timestamp.
    • getCompletedAt

      public Optional<String> getCompletedAt()
      Returns:
      When the export finished, as an ISO-8601 UTC timestamp. Null until status is completed.
    • getDownloadUrl

      public Optional<String> getDownloadUrl()
      Returns:
      Short-lived presigned URL for downloading the serialized export payload. Present once status is completed; null while the job is accepted or processing. Treat it as a secret — anyone with the URL can download the data until it expires.
    • getExpiresAt

      public Optional<String> getExpiresAt()
      Returns:
      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 status is completed.
    • getFailureReason

      public Optional<String> getFailureReason()
      Returns:
      Reason the export failed, suitable for display or programmatic handling. Present only when status is failed; null otherwise.
    • getManifest

      public Optional<ExportManifest> getManifest()
    • 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 ExportRequestResponse.Builder builder()