Package com.qtsurfer.api.client.model

Class DatasetImportRequest

java.lang.Object

com.qtsurfer.api.client.model.DatasetImportRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.14.0")
public class DatasetImportRequest
extends Object

`POST /datasets/imports`'s request body. A common block plus one type-specific block, selected by `type` — `dex` is the only value today.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DatasetImportRequest.CadenceEnum	Optional.
static enum	DatasetImportRequest.TypeEnum	The source to fetch from.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CADENCE
static final String	JSON_PROPERTY_DEX
static final String	JSON_PROPERTY_FROM
static final String	JSON_PROPERTY_INSTRUMENT
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_TO
static final String	JSON_PROPERTY_TYPE

Constructor Summary

Constructors

Constructor	Description
DatasetImportRequest()

Method Summary

Modifier and Type	Method	Description
DatasetImportRequest	cadence(DatasetImportRequest.CadenceEnum cadence)
DatasetImportRequest	dex(DatasetImportDexRequest dex)
boolean	equals(Object o)	Return true if this DatasetImportRequest object is equal to o.
DatasetImportRequest	from(OffsetDateTime from)
DatasetImportRequest.CadenceEnum	getCadence()	Optional.
DatasetImportDexRequest	getDex()	Get dex
OffsetDateTime	getFrom()	Start of the range to fetch, inclusive.
String	getInstrument()	Exchange instrument identifier (e.g.
String	getName()	A name unique among your datasets.
OffsetDateTime	getTo()	End of the range to fetch, exclusive.
DatasetImportRequest.TypeEnum	getType()	The source to fetch from.
int	hashCode()
DatasetImportRequest	instrument(String instrument)
DatasetImportRequest	name(String name)
void	setCadence(DatasetImportRequest.CadenceEnum cadence)
void	setDex(DatasetImportDexRequest dex)
void	setFrom(OffsetDateTime from)
void	setInstrument(String instrument)
void	setName(String name)
void	setTo(OffsetDateTime to)
void	setType(DatasetImportRequest.TypeEnum type)
DatasetImportRequest	to(OffsetDateTime to)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
DatasetImportRequest	type(DatasetImportRequest.TypeEnum type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_INSTRUMENT

public static final String JSON_PROPERTY_INSTRUMENT

See Also:

• Constant Field Values

JSON_PROPERTY_FROM

public static final String JSON_PROPERTY_FROM

See Also:

• Constant Field Values

JSON_PROPERTY_TO

public static final String JSON_PROPERTY_TO

See Also:

• Constant Field Values

JSON_PROPERTY_CADENCE

public static final String JSON_PROPERTY_CADENCE

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_DEX

public static final String JSON_PROPERTY_DEX

See Also:

• Constant Field Values

Constructor Details

DatasetImportRequest

public DatasetImportRequest()

Method Details

name

public DatasetImportRequest name(@Nonnull
 String name)

getName

@Nonnull
public String getName()

A name unique among your datasets. `409` if already taken.

Returns:

name

setName

public void setName(@Nonnull
 String name)

instrument

public DatasetImportRequest instrument(@Nonnull
 String instrument)

getInstrument

@Nonnull
public String getInstrument()

Exchange instrument identifier (e.g. a currency pair)

Returns:

instrument

setInstrument

public void setInstrument(@Nonnull
 String instrument)

from

public DatasetImportRequest from(@Nonnull
 OffsetDateTime from)

getFrom

@Nonnull
public OffsetDateTime getFrom()

Start of the range to fetch, inclusive. Must be before `to`.

Returns:

from

setFrom

public void setFrom(@Nonnull
 OffsetDateTime from)

to

public DatasetImportRequest to(@Nonnull
 OffsetDateTime to)

getTo

@Nonnull
public OffsetDateTime getTo()

End of the range to fetch, exclusive. The total span is capped by your tier — a request wider than that ceiling is `400`, regardless of source type.

Returns:

to

setTo

public void setTo(@Nonnull
 OffsetDateTime to)

cadence

public DatasetImportRequest cadence(@Nullable
 DatasetImportRequest.CadenceEnum cadence)

getCadence

@Nullable
public DatasetImportRequest.CadenceEnum getCadence()

Optional. Omitted/blank keeps native per-trade event cadence — each swap at its own timestamp, so the resulting version's `cadence` is `rt` unless the swaps happen to sit on a fixed grid (see `DatasetVersion.cadence`). Set to `1s`, `1m` or `5m` instead to get pre-aggregated candles at that width rather than raw trades (the resulting dataset's `type` becomes `klines`); any other value is `400`. Not every network supports every cadence — an unsupported combination fails asynchronously, not at request time (see `DatasetImportState.error`).

Returns:

cadence

setCadence

public void setCadence(@Nullable
 DatasetImportRequest.CadenceEnum cadence)

type

public DatasetImportRequest type(@Nonnull
 DatasetImportRequest.TypeEnum type)

getType

@Nonnull
public DatasetImportRequest.TypeEnum getType()

The source to fetch from. `dex` is the only value today.

Returns:

type

setType

public void setType(@Nonnull
 DatasetImportRequest.TypeEnum type)

dex

public DatasetImportRequest dex(@Nullable
 DatasetImportDexRequest dex)

getDex

@Nullable
public DatasetImportDexRequest getDex()

Get dex

Returns:

dex

setDex

public void setDex(@Nullable
 DatasetImportDexRequest dex)

equals

public boolean equals(Object o)

Return true if this DatasetImportRequest 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