Package com.qtsurfer.api.client.model

Class DatasetUploadState

java.lang.Object
com.qtsurfer.api.client.model.DatasetUploadState
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.14.0") public class DatasetUploadState extends Object
Progress of one upload, from staged through ingest. Durably recorded once a version exists, so `ready`/`failed` are permanent answers; `uploading`/`ingesting` reflect in-flight state that can itself age out — see the `404` case on `GET .../uploads/{uploadId}`.

  • Field Details

  • Constructor Details

    • DatasetUploadState

      public DatasetUploadState()

  • Method Details

    • uploadId

      public DatasetUploadState uploadId(@Nonnull String uploadId)

    • getUploadId

      @Nonnull public String getUploadId()
      Get uploadId
      Returns:
      uploadId

    • setUploadId

      public void setUploadId(@Nonnull String uploadId)

    • status

      public DatasetUploadState status(@Nonnull DatasetUploadState.StatusEnum status)

    • getStatus

      @Nonnull public DatasetUploadState.StatusEnum getStatus()
      * `uploading` — the file was PUT to the presigned URL, but `finalize` has not been called yet. * `ingesting` — `finalize` was called; the worker is parsing and validating the file. * `ready` — ingested successfully. `version` carries the result. * `failed` — ingest rejected the file (e.g. bad CSV contract, mixed timestamp units, a `.zip` with no file inside or more than one).
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull DatasetUploadState.StatusEnum status)

    • jobId

      public DatasetUploadState jobId(@Nullable String jobId)

    • getJobId

      @Nullable public String getJobId()
      The ingest job id, while `status` is `ingesting`.
      Returns:
      jobId

    • setJobId

      public void setJobId(@Nullable String jobId)

    • error

      public DatasetUploadState error(@Nullable String error)

    • getError

      @Nullable public String getError()
      A human-readable reason, present when `status` is `failed` (e.g. bad CSV contract, mixed timestamp units, a `.zip` with no file inside or more than one). Durably recorded alongside the failure itself, so it stays available however long after the fact you poll — not tied to how recently the failure happened.
      Returns:
      error

    • setError

      public void setError(@Nullable String error)

    • version

      public DatasetUploadState version(@Nullable DatasetVersion version)

    • getVersion

      @Nullable public DatasetVersion getVersion()
      Present when `status` is `ready` or `failed`.
      Returns:
      version

    • setVersion

      public void setVersion(@Nullable DatasetVersion version)

    • equals

      public boolean equals(Object o)
      Return true if this DatasetUploadState object is equal to o.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string