Struct SubmitJobParams

pub struct SubmitJobParams {

    pub dataset: String,
    pub symbols: Symbols,
    pub schema: Schema,
    pub date_time_range: DateTimeRange,
    pub encoding: Encoding,
    pub compression: Compression,
    pub pretty_px: bool,
    pub pretty_ts: bool,
    pub map_symbols: bool,
    pub split_symbols: bool,
    pub split_duration: Option<SplitDuration>,
    pub split_size: Option<NonZeroU64>,
    pub delivery: Delivery,
    pub stype_in: SType,
    pub stype_out: SType,
    pub limit: Option<NonZeroU64>,
}

Available on crate feature historical only.

The parameters for BatchClient::submit_job(). Use SubmitJobParams::builder() to get a builder type with all the preset defaults.

Fields

dataset: String

The dataset code.

symbols: Symbols

The symbols to filter for.

schema: Schema

The data record schema.

date_time_range: DateTimeRange

The date time request range. Filters on ts_recv if it exists in the schema, otherwise ts_event.

encoding: Encoding

The data encoding. Defaults to Dbn.

compression: Compression

The data compression mode. Defaults to ZStd.

pretty_px: bool

If true, prices will be formatted to the correct scale (using the fixed- precision scalar 1e-9). Only valid for Encoding::Csv and Encoding::Json.

pretty_ts: bool

If true, timestamps will be formatted as ISO 8601 strings. Only valid for Encoding::Csv and Encoding::Json.

map_symbols: bool

If true, a symbol field will be included with each text-encoded record, reducing the need to look at the symbology.json. Only valid for Encoding::Csv and Encoding::Json.

split_symbols: bool

If true, files will be split by raw symbol. Cannot be requested with Symbols::All.

split_duration: Option<SplitDuration>

The maximum time duration before batched data is split into multiple files. If None the data will not be split by time. Defaults to Day.

split_size: Option<NonZeroU64>

The optional maximum size (in bytes) of each batched data file before being split. Must be an integer between 1e9 and 10e9 inclusive (1GB - 10GB). Defaults to None.

delivery: Delivery

The delivery mechanism for the batched data files once processed. Defaults to Download.

stype_in: SType

The symbology type of the input symbols. Defaults to RawSymbol.

stype_out: SType

The symbology type of the output symbols. Defaults to InstrumentId.

limit: Option<NonZeroU64>

The optional maximum number of records to return. Defaults to no limit.

Implementations

impl SubmitJobParams

pub fn builder() -> SubmitJobParamsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building SubmitJobParams. On the builder, call .dataset(...), .symbols(...), .schema(...), .date_time_range(...), .encoding(...)(optional), .compression(...)(optional), .pretty_px(...)(optional), .pretty_ts(...)(optional), .map_symbols(...)(optional), .split_symbols(...)(optional), .split_duration(...)(optional), .split_size(...)(optional), .delivery(...)(optional), .stype_in(...)(optional), .stype_out(...)(optional), .limit(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of SubmitJobParams.

Trait Implementations

impl Clone for SubmitJobParams

fn clone(&self) -> SubmitJobParams

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SubmitJobParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SubmitJobParams

fn eq(&self, other: &SubmitJobParams) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SubmitJobParams

impl StructuralPartialEq for SubmitJobParams