Package com.qtsurfer.api.client.model

Class DatasetVersion

java.lang.Object
com.qtsurfer.api.client.model.DatasetVersion
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.14.0") public class DatasetVersion extends Object
One successfully ingested upload. Cadence and timestamp unit are discovered from the file, not declared by the caller.

  • Field Details

  • Constructor Details

    • DatasetVersion

      public DatasetVersion()

  • Method Details

    • datasetId

      public DatasetVersion datasetId(@Nonnull String datasetId)

    • getDatasetId

      @Nonnull public String getDatasetId()
      Get datasetId
      Returns:
      datasetId

    • setDatasetId

      public void setDatasetId(@Nonnull String datasetId)

    • id

      public DatasetVersion id(@Nullable String id)

    • getId

      @Nullable public String getId()
      The version id. Pass as `datasetVersionId` on `POST .../prepare` to pin it.
      Returns:
      id

    • setId

      public void setId(@Nullable String id)

    • bytes

      public DatasetVersion bytes(@Nullable Integer bytes)

    • getBytes

      @Nullable public Integer getBytes()
      Size of the stored file `dataUrl` points at — a converted `lastra` for a CSV/gzip/zip upload, or the parquet file itself, unconverted, for a parquet upload. Not the size of the bytes originally PUT to storage; see `dataFormat`.
      Returns:
      bytes

    • setBytes

      public void setBytes(@Nullable Integer bytes)

    • rows

      public DatasetVersion rows(@Nullable Integer rows)

    • getRows

      @Nullable public Integer getRows()
      Number of data rows.
      Returns:
      rows

    • setRows

      public void setRows(@Nullable Integer rows)

    • cadence

      public DatasetVersion cadence(@Nullable String cadence)

    • getCadence

      @Nullable public String getCadence()
      The cadence discovered from the data's own timestamps. Either a fixed grid — `1s`, `5s`, `15s`, `1m`, `5m`, `15m`, `30m`, `1h`, `4h`, `1d` — when at least half the intervals between consecutive rows fall on that step (small clock jitter tolerated), or `rt`: native data at the rate it was captured, each row at its own timestamp with no fixed step — per-trade on-chain swaps, block-spaced or sub-second ticks, irregular intervals. An `rt` dataset can be resampled to any fixed cadence at prepare time.
      Returns:
      cadence

    • setCadence

      public void setCadence(@Nullable String cadence)

    • timestampUnit

      public DatasetVersion timestampUnit(@Nullable DatasetVersion.TimestampUnitEnum timestampUnit)

    • getTimestampUnit

      @Nullable public DatasetVersion.TimestampUnitEnum getTimestampUnit()
      The unit the `timestamp` column was uploaded in — ISO-8601, or the epoch band its numeric values fell in (seconds, millis, or micros).
      Returns:
      timestampUnit

    • setTimestampUnit

      public void setTimestampUnit(@Nullable DatasetVersion.TimestampUnitEnum timestampUnit)

    • gaps

      public DatasetVersion gaps(@Nullable Integer gaps)

    • getGaps

      @Nullable public Integer getGaps()
      Number of gaps at the discovered cadence. Always `0` for `rt`.
      Returns:
      gaps

    • setGaps

      public void setGaps(@Nullable Integer gaps)

    • largestGapSteps

      public DatasetVersion largestGapSteps(@Nullable Integer largestGapSteps)

    • getLargestGapSteps

      @Nullable public Integer getLargestGapSteps()
      The largest gap, in units of the discovered cadence step. Always `0` for `rt`.
      Returns:
      largestGapSteps

    • setLargestGapSteps

      public void setLargestGapSteps(@Nullable Integer largestGapSteps)

    • dataUrl

      public DatasetVersion dataUrl(@Nullable String dataUrl)

    • getDataUrl

      @Nullable public String getDataUrl()
      Presigned GET URL to the stored file — see `dataFormat` for which format it's in. Present once the version is `ready`. Long-lived (day-scale, not permanent): a DuckDB-WASM/`lastra-ts`-style reader issues HTTP range requests against it lazily over an extended viewing session, not in one shot like a browser upload.
      Returns:
      dataUrl

    • setDataUrl

      public void setDataUrl(@Nullable String dataUrl)

    • dataFormat

      public DatasetVersion dataFormat(@Nullable DatasetVersion.DataFormatEnum dataFormat)

    • getDataFormat

      @Nullable public DatasetVersion.DataFormatEnum getDataFormat()
      Which format `dataUrl` is actually in — check this rather than assuming it matches how you uploaded it. `lastra` — our native columnar format — for a CSV (or gzip/zip of one) upload, always converted on ingest, or for a lastra upload, stored as-is (the value alone doesn't tell you which). `parquet` for a parquet upload, also stored as-is today.
      Returns:
      dataFormat

    • setDataFormat

      public void setDataFormat(@Nullable DatasetVersion.DataFormatEnum dataFormat)

    • equals

      public boolean equals(Object o)
      Return true if this DatasetVersion 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