Package org.springframework.data.redis.connection

Class RedisStreamCommands.XAddOptions

java.lang.Object

org.springframework.data.redis.connection.RedisStreamCommands.XAddOptions

Enclosing interface:

RedisStreamCommands

@NullMarked
public static class RedisStreamCommands.XAddOptions
extends Object

Additional options applicable for XADD command.

Since:

2.3

Author:

Christoph Strobl, Mark John Moreno, Liming Deng

Field Summary

Fields

Modifier and Type	Field	Description
static RedisStreamCommands.XAddOptions	NONE

Method Summary

Modifier and Type	Method	Description
RedisStreamCommands.XAddOptions	approximateTrimming(boolean approximateTrimming)	Deprecated. since 4.0: callers must specify a concrete trim strategy (MAXLEN or MINID) via RedisStreamCommands.TrimOptions; do not use this method to only toggle approximate/exact.
boolean	equals(@Nullable Object o)
@Nullable Long	getMaxlen()	Limit the size of the stream to the given maximum number of elements.
@Nullable RecordId	getMinId()
@Nullable RedisStreamCommands.TrimOptions	getTrimOptions()
int	hashCode()
boolean	hasMaxlen()
boolean	hasMinId()
boolean	hasTrimOptions()
boolean	isApproximateTrimming()
boolean	isNoMkStream()
static RedisStreamCommands.XAddOptions	makeNoStream()	Disable creation of stream if it does not already exist.
static RedisStreamCommands.XAddOptions	makeNoStream(boolean makeNoStream)	Whether to disable creation of stream if it does not already exist.
static RedisStreamCommands.XAddOptions	maxlen(long maxlen)	Limit the size of the stream to the given maximum number of elements.
RedisStreamCommands.XAddOptions	minId(RecordId minId)	Apply MINID trimming strategy, that evicts entries with IDs lower than the one specified.
RedisStreamCommands.XAddOptions	nomkstream(boolean nomkstream)
static RedisStreamCommands.XAddOptions	none()	Create default add options.
static RedisStreamCommands.XAddOptions	trim(@Nullable RedisStreamCommands.TrimOptions trimOptions)

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static RedisStreamCommands.XAddOptions NONE

Method Details

none

public static RedisStreamCommands.XAddOptions none()

Create default add options.

Returns:

new instance of RedisStreamCommands.XAddOptions with default values

Since:

2.6

trim

public static RedisStreamCommands.XAddOptions trim(@Nullable RedisStreamCommands.TrimOptions trimOptions)

makeNoStream

public static RedisStreamCommands.XAddOptions makeNoStream()

Disable creation of stream if it does not already exist.

Returns:

new instance of RedisStreamCommands.XAddOptions.

Since:

2.6

makeNoStream

public static RedisStreamCommands.XAddOptions makeNoStream(boolean makeNoStream)

Whether to disable creation of stream if it does not already exist.

Parameters:

makeNoStream - true to not create a stream if it does not already exist.

Returns:

new instance of RedisStreamCommands.XAddOptions.

Since:

2.6

maxlen

public static RedisStreamCommands.XAddOptions maxlen(long maxlen)

Limit the size of the stream to the given maximum number of elements.

Returns:

new instance of RedisStreamCommands.XAddOptions.

minId

public RedisStreamCommands.XAddOptions minId(RecordId minId)

Apply MINID trimming strategy, that evicts entries with IDs lower than the one specified.

Parameters:

minId - the minimum record Id to retain.

Returns:

new instance of RedisStreamCommands.XAddOptions.

Since:

2.7

approximateTrimming

@Deprecated(since="4.0",
            forRemoval=false)
public RedisStreamCommands.XAddOptions approximateTrimming(boolean approximateTrimming)

Deprecated.

since 4.0: callers must specify a concrete trim strategy (MAXLEN or MINID) via RedisStreamCommands.TrimOptions; do not use this method to only toggle approximate/exact. Prefer XAddOptions.trim(TrimOptions.maxLen(n).approximate()) or XAddOptions.trim(TrimOptions.minId(id).exact()).

Apply efficient trimming for capped streams using the ~ flag.

Returns:

new instance of RedisStreamCommands.XAddOptions.

isNoMkStream

public boolean isNoMkStream()

Returns:

true if NOMKSTREAM is set.

Since:

2.6

getMaxlen

public @Nullable Long getMaxlen()

Limit the size of the stream to the given maximum number of elements.

Returns:

can be null.

hasMaxlen

public boolean hasMaxlen()

Returns:

true if MAXLEN is set.

isApproximateTrimming

public boolean isApproximateTrimming()

Returns:

true if approximateTrimming is set.

getMinId

public @Nullable RecordId getMinId()

Returns:

the minimum record id to retain during trimming.

Since:

2.7

hasMinId

public boolean hasMinId()

Returns:

true if MINID is set.

Since:

2.7

nomkstream

public RedisStreamCommands.XAddOptions nomkstream(boolean nomkstream)

hasTrimOptions

public boolean hasTrimOptions()

getTrimOptions

public @Nullable RedisStreamCommands.TrimOptions getTrimOptions()

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object