Class RedisStreamCommands.XPendingOptions
java.lang.Object
org.springframework.data.redis.connection.RedisStreamCommands.XPendingOptions
- Enclosing interface:
- RedisStreamCommands
Value Object holding parameters for obtaining pending messages.
- Since:
- 2.3
- Author:
- Christoph Strobl
-
Method Summary
Modifier and TypeMethodDescriptionAppend given consumer.getCount()
org.springframework.data.domain.Range<?>
getRange()
boolean
boolean
Create newRedisStreamCommands.XPendingOptions
with givenRange
and limit.Create newRedisStreamCommands.XPendingOptions
with an unboundedRange
(- +).Create newRedisStreamCommands.XPendingOptions
with an unboundedRange
(- +).
-
Method Details
-
unbounded
Create newRedisStreamCommands.XPendingOptions
with an unboundedRange
(- +).- Returns:
- new instance of
RedisStreamCommands.XPendingOptions
.
-
unbounded
Create newRedisStreamCommands.XPendingOptions
with an unboundedRange
(- +).- Parameters:
count
- the max number of messages to return. Must not be null.- Returns:
- new instance of
RedisStreamCommands.XPendingOptions
.
-
range
public static RedisStreamCommands.XPendingOptions range(org.springframework.data.domain.Range<?> range, Long count) Create newRedisStreamCommands.XPendingOptions
with givenRange
and limit.- Returns:
- new instance of
RedisStreamCommands.XPendingOptions
.
-
consumer
Append given consumer.- Parameters:
consumerName
- must not be null.- Returns:
- new instance of
RedisStreamCommands.XPendingOptions
.
-
getRange
public org.springframework.data.domain.Range<?> getRange()- Returns:
- never null.
-
getCount
- Returns:
- can be null.
-
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.
-