Class DatasetImportState

java.lang.Object
com.qtsurfer.api.client.model.DatasetImportState

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.14.0") public class DatasetImportState extends Object
Progress of one import, from fetching through ingest. `fetching` is the one status only an import ever reports — an upload's file already exists by the time you can poll it; an import's doesn't, until this source finishes fetching it.
  • Field Details

  • Constructor Details

    • DatasetImportState

      public DatasetImportState()
  • Method Details

    • importId

      public DatasetImportState importId(@Nonnull String importId)
    • getImportId

      @Nonnull public String getImportId()
      Get importId
      Returns:
      importId
    • setImportId

      public void setImportId(@Nonnull String importId)
    • status

      public DatasetImportState status(@Nonnull DatasetImportState.StatusEnum status)
    • getStatus

      @Nonnull public DatasetImportState.StatusEnum getStatus()
      * `fetching` — reading from the source; nothing staged yet. * `ingesting` — fetch complete, staged, and re-entered the same ingest chain an upload uses; the worker is parsing and validating it. * `ready` — ingested successfully. `version` carries the result. * `failed` — the fetch or the ingest that followed it was rejected. `error` names why.
      Returns:
      status
    • setStatus

      public void setStatus(@Nonnull DatasetImportState.StatusEnum status)
    • jobId

      public DatasetImportState jobId(@Nullable String jobId)
    • getJobId

      @Nullable public String getJobId()
      The fetch/ingest job id, while `status` is `fetching` or `ingesting`.
      Returns:
      jobId
    • setJobId

      public void setJobId(@Nullable String jobId)
    • error

      public DatasetImportState error(@Nullable String error)
    • getError

      @Nullable public String getError()
      A human-readable reason, present when `status` is `failed` — an unresolvable pool/pair, no data in the requested range, a range older than the configured source retains, the fetch exceeding your tier's time ceiling, or any of `DatasetUploadState.error`'s own ingest-side reasons once fetching hands off to it. Durably recorded, same as on the upload path.
      Returns:
      error
    • setError

      public void setError(@Nullable String error)
    • version

      public DatasetImportState 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 DatasetImportState 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