Package io.quarkus.redis.datasource.timeseries

Class AddArgs

java.lang.Object

io.quarkus.redis.datasource.timeseries.AddArgs

All Implemented Interfaces:

RedisCommandExtraArguments

public class AddArgs
extends Object
implements RedisCommandExtraArguments

Represents the extra arguments of the ts.add command.

Constructor Summary

Constructors

Constructor	Description
AddArgs()

Method Summary

Modifier and Type	Method	Description
AddArgs	chunkSize(int size)	Sets the memory size, in bytes, allocated for each data chunk.
AddArgs	compressed()	Set the series sample's encoding format to COMPRESSED Use it only if you are creating a new time series.
AddArgs	label(String label, Object value)	Set a label-value pairs that represent metadata labels of the time series.
AddArgs	onDuplicate(DuplicatePolicy policy)	Overwrite key and database configuration for DUPLICATE_POLICY, the policy for handling samples with identical timestamps.
AddArgs	setRetention(Duration retention)	Set the maximum retention period, compared to the maximum existing timestamp, in milliseconds.
List<Object>	toArgs()
AddArgs	uncompressed()	Set the series sample's encoding format to UNCOMPRESSED Use it only if you are creating a new time series.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.quarkus.redis.datasource.RedisCommandExtraArguments

toArgs

Constructor Detail

AddArgs

public AddArgs()

Method Detail

setRetention

public AddArgs setRetention(Duration retention)

Set the maximum retention period, compared to the maximum existing timestamp, in milliseconds.

Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series.

Parameters:

retention - the retention, must not be null

Returns:

the current AddArgs

compressed

public AddArgs compressed()

Set the series sample's encoding format to COMPRESSED Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series.

Returns:

the current AddArgs

uncompressed

public AddArgs uncompressed()

Set the series sample's encoding format to UNCOMPRESSED Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series.

Returns:

the current AddArgs

chunkSize

public AddArgs chunkSize(int size)

Sets the memory size, in bytes, allocated for each data chunk. Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series.

Parameters:

size - the chunk size, between 48 and 1048576

Returns:

the current AddArgs

onDuplicate

public AddArgs onDuplicate(DuplicatePolicy policy)

Overwrite key and database configuration for DUPLICATE_POLICY, the policy for handling samples with identical timestamps.

Parameters:

policy - the policy, must not be null

Returns:

the current AddArgs

label

public AddArgs label(String label,
                     Object value)

Set a label-value pairs that represent metadata labels of the time series.

Parameters:

label - the label, must not be null

value - the value, must not be null

Returns:

the current AddArgs

toArgs

public List<Object> toArgs()

Specified by:

toArgs in interface RedisCommandExtraArguments

Returns:

the list of arguments.