Class ReactiveStreamCommands.AddStreamRecord

java.lang.Object

org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand

org.springframework.data.redis.connection.ReactiveStreamCommands.AddStreamRecord

All Implemented Interfaces:

ReactiveRedisConnection.Command

Enclosing interface:

ReactiveStreamCommands

public static class ReactiveStreamCommands.AddStreamRecord
extends ReactiveRedisConnection.KeyCommand

XADD command parameters.

Since:

2.2

Author:

Mark Paluch, Christoph Strobl, Tugdual Grall, Dengliming, Mark John Moreno, jinkshower, Jeonggyu Choi

See Also:

• Redis Documentation: XADD

Method Summary

Modifier and Type	Method	Description
ReactiveStreamCommands.AddStreamRecord	approximateTrimming(boolean approximateTrimming)	Apply efficient trimming for capped streams using the ~ flag.
static ReactiveStreamCommands.AddStreamRecord	body(Map<ByteBuffer, ByteBuffer> body)	Creates a new ReactiveStreamCommands.AddStreamRecord given body.
Map<ByteBuffer, ByteBuffer>	getBody()
@Nullable Long	getMaxlen()	Limit the size of the stream to the given maximum number of elements.
@Nullable RecordId	getMinId()
ByteBufferRecord	getRecord()
boolean	hasMaxlen()
boolean	hasMinId()
boolean	isApproximateTrimming()
boolean	isNoMkStream()
ReactiveStreamCommands.AddStreamRecord	makeNoStream()	Disable creation of stream if it does not already exist.
ReactiveStreamCommands.AddStreamRecord	makeNoStream(boolean makeNoStream)	Disable creation of stream if it does not already exist.
ReactiveStreamCommands.AddStreamRecord	maxlen(long maxlen)	Limit the size of the stream to the given maximum number of elements.
ReactiveStreamCommands.AddStreamRecord	minId(RecordId minId)	Apply MINID trimming strategy, that evicts entries with IDs lower than the one specified.
static ReactiveStreamCommands.AddStreamRecord	of(ByteBufferRecord record)	Creates a new ReactiveStreamCommands.AddStreamRecord given body.
ReactiveStreamCommands.AddStreamRecord	to(ByteBuffer key)	Applies the Geo set key.

Methods inherited from class ReactiveRedisConnection.KeyCommand

getKey

Methods inherited from class Object

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

Methods inherited from interface ReactiveRedisConnection.Command

getName

Method Details

of

public static ReactiveStreamCommands.AddStreamRecord of(ByteBufferRecord record)

Creates a new ReactiveStreamCommands.AddStreamRecord given body.

Parameters:

record - must not be null.

Returns:

a new ReactiveStreamCommands.AddStreamRecord.

body

public static ReactiveStreamCommands.AddStreamRecord body(Map<ByteBuffer, ByteBuffer> body)

Creates a new ReactiveStreamCommands.AddStreamRecord given body.

Parameters:

body - must not be null.

Returns:

a new ReactiveStreamCommands.AddStreamRecord for Map.

to

public ReactiveStreamCommands.AddStreamRecord to(ByteBuffer key)

Applies the Geo set key. Constructs a new command instance with all previously configured properties.

Parameters:

key - must not be null.

Returns:

a new ReactiveGeoCommands.GeoAddCommand with key applied.

makeNoStream

public ReactiveStreamCommands.AddStreamRecord makeNoStream()

Disable creation of stream if it does not already exist.

Returns:

new instance of ReactiveStreamCommands.AddStreamRecord.

Since:

2.6

makeNoStream

public ReactiveStreamCommands.AddStreamRecord makeNoStream(boolean makeNoStream)

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 ReactiveStreamCommands.AddStreamRecord.

Since:

2.6

maxlen

public ReactiveStreamCommands.AddStreamRecord maxlen(long maxlen)

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

Returns:

new instance of ReactiveStreamCommands.AddStreamRecord.

minId

public ReactiveStreamCommands.AddStreamRecord 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 ReactiveStreamCommands.AddStreamRecord.

Since:

2.7

approximateTrimming

public ReactiveStreamCommands.AddStreamRecord approximateTrimming(boolean approximateTrimming)

Apply efficient trimming for capped streams using the ~ flag.

Returns:

new instance of ReactiveStreamCommands.AddStreamRecord.

getBody

public Map<ByteBuffer, ByteBuffer> getBody()

Returns:

the actual Record.getValue()

getRecord

public ByteBufferRecord getRecord()

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.

Since:

2.3

hasMaxlen

public boolean hasMaxlen()

Returns:

true if MAXLEN is set.

Since:

2.3

isApproximateTrimming

public boolean isApproximateTrimming()

Returns:

true if approximateTrimming is set.

Since:

2.7

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