Class ReactiveStreamCommands.PendingRecordsCommand

java.lang.Object

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

org.springframework.data.redis.connection.ReactiveStreamCommands.PendingRecordsCommand

All Implemented Interfaces:

ReactiveRedisConnection.Command

Enclosing interface:

ReactiveStreamCommands

public static class ReactiveStreamCommands.PendingRecordsCommand
extends ReactiveRedisConnection.KeyCommand

Value Object holding parameters for obtaining pending messages.

Since:

2.3

Author:

Christoph Strobl, Jeonggyu Choi

Method Summary

Modifier and Type	Method	Description
ReactiveStreamCommands.PendingRecordsCommand	consumer(String consumerName)	Append given consumer.
@Nullable String	getConsumerName()
@Nullable Long	getCount()
String	getGroupName()
@Nullable Duration	getMinIdleTime()
Range<?>	getRange()
boolean	hasConsumer()
boolean	hasMinIdleTime()
boolean	isLimited()
ReactiveStreamCommands.PendingRecordsCommand	minIdleTime(Duration minIdleTime)	Append given minimum idle time.
ReactiveStreamCommands.PendingRecordsCommand	range(Range<?> range, Long count)	Create new ReactiveStreamCommands.PendingRecordsCommand with given Range and limit.

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

range

public ReactiveStreamCommands.PendingRecordsCommand range(Range<?> range,
 Long count)

Create new ReactiveStreamCommands.PendingRecordsCommand with given Range and limit.

Parameters:

range - must not be null.

count - the max number of messages to return. Must not be negative.

Returns:

new instance of RedisStreamCommands.XPendingOptions.

consumer

public ReactiveStreamCommands.PendingRecordsCommand consumer(String consumerName)

Append given consumer.

Parameters:

consumerName - must not be null.

Returns:

new instance of ReactiveStreamCommands.PendingRecordsCommand.

minIdleTime

public ReactiveStreamCommands.PendingRecordsCommand minIdleTime(Duration minIdleTime)

Append given minimum idle time.

Parameters:

minIdleTime - must not be null.

Returns:

new instance of ReactiveStreamCommands.PendingRecordsCommand.

Since:

4.0

getGroupName

public String getGroupName()

getConsumerName

public @Nullable String getConsumerName()

Returns:

can be null.

getRange

public Range<?> getRange()

Returns:

never null.

getCount

public @Nullable Long getCount()

Returns:

can be null.

getMinIdleTime

public @Nullable Duration getMinIdleTime()

Returns:

can be null.

hasConsumer

public boolean hasConsumer()

Returns:

true if a consumer name is present.

isLimited

public boolean isLimited()

Returns:

true count is set.

hasMinIdleTime

public boolean hasMinIdleTime()

Returns:

true if idle is set.