Package org.springframework.data.redis.connection

Class RedisStreamCommands.XPendingOptions

java.lang.Object

org.springframework.data.redis.connection.RedisStreamCommands.XPendingOptions

Enclosing interface:

RedisStreamCommands

public static class RedisStreamCommands.XPendingOptions
extends Object

Value Object holding parameters for obtaining pending messages.

Since:

2.3

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method	Description
RedisStreamCommands.XPendingOptions	consumer(String consumerName)	Append given consumer.
String	getConsumerName()
Long	getCount()
Range<?>	getRange()
boolean	hasConsumer()
boolean	isLimited()
static RedisStreamCommands.XPendingOptions	range(Range<?> range, Long count)	Create new RedisStreamCommands.XPendingOptions with given Range and limit.
static RedisStreamCommands.XPendingOptions	unbounded()	Create new RedisStreamCommands.XPendingOptions with an unbounded Range (- +).
static RedisStreamCommands.XPendingOptions	unbounded(Long count)	Create new RedisStreamCommands.XPendingOptions with an unbounded Range (- +).

Methods inherited from class java.lang.Object

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

Method Details

unbounded

public static RedisStreamCommands.XPendingOptions unbounded()

Create new RedisStreamCommands.XPendingOptions with an unbounded Range (- +).

Returns:

new instance of RedisStreamCommands.XPendingOptions.

unbounded

public static RedisStreamCommands.XPendingOptions unbounded(Long count)

Create new RedisStreamCommands.XPendingOptions with an unbounded Range (- +).

Parameters:

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

Returns:

new instance of RedisStreamCommands.XPendingOptions.

range

public static RedisStreamCommands.XPendingOptions range(Range<?> range,
 Long count)

Create new RedisStreamCommands.XPendingOptions 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 RedisStreamCommands.XPendingOptions consumer(String consumerName)

Append given consumer.

Parameters:

consumerName - must not be null.

Returns:

new instance of RedisStreamCommands.XPendingOptions.

getRange

public Range<?> getRange()

Returns:

never null.

getCount

@Nullable
public Long getCount()

Returns:

can be null.

getConsumerName

@Nullable
public String getConsumerName()

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.