Struct databento::historical::batch::SubmitJobParams
source · pub struct SubmitJobParams {Show 17 fields
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: SplitDuration,
pub split_size: Option<NonZeroU64>,
pub packaging: Option<Packaging>,
pub delivery: Delivery,
pub stype_in: SType,
pub stype_out: SType,
pub limit: Option<NonZeroU64>,
}
historical
only.Expand description
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 request time range.
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: SplitDuration
The maximum time duration before batched data is split into multiple files.
Defaults to Day
.
split_size: Option<NonZeroU64>
The optional maximum size (in bytes) of each batched data file before being split.
Defaults to None
.
packaging: Option<Packaging>
The optional archive type to package all batched data files in. 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§
source§impl SubmitJobParams
impl SubmitJobParams
sourcepub fn builder() -> SubmitJobParamsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>
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), .packaging(...)
(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§
source§impl Clone for SubmitJobParams
impl Clone for SubmitJobParams
source§fn clone(&self) -> SubmitJobParams
fn clone(&self) -> SubmitJobParams
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for SubmitJobParams
impl Debug for SubmitJobParams
source§impl PartialEq for SubmitJobParams
impl PartialEq for SubmitJobParams
source§fn eq(&self, other: &SubmitJobParams) -> bool
fn eq(&self, other: &SubmitJobParams) -> bool
self
and other
values to be equal, and is used
by ==
.impl Eq for SubmitJobParams
impl StructuralPartialEq for SubmitJobParams
Auto Trait Implementations§
impl Freeze for SubmitJobParams
impl RefUnwindSafe for SubmitJobParams
impl Send for SubmitJobParams
impl Sync for SubmitJobParams
impl Unpin for SubmitJobParams
impl UnwindSafe for SubmitJobParams
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.