Class RedisStreamCommands.XClaimOptions
java.lang.Object
org.springframework.data.redis.connection.RedisStreamCommands.XClaimOptions
- Enclosing interface:
- RedisStreamCommands
- Since:
- 2.3
- Author:
- Christoph Strobl
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
-
Method Summary
Modifier and TypeMethodDescriptionforce()
Forces creation of a pending message entry in the PEL even if it does not already exist as long a the given stream record id is valid.Get the IDLE ms time.getIds()
Get theList
of ID.String[]
Get the ID array asstrings
.Get the min-idle-time.Get the RETRYCOUNT count.Get the TIME ms-unix-timeSet the idle time since last delivery of a message.boolean
isForce()
Get the FORCE flag.Set the min-idle-time to limit the command to messages that have been idle for at at least the givenDuration
.minIdleMs
(long millis) Set the min-idle-time to limit the command to messages that have been idle for at at least the given milliseconds.retryCount
(long retryCount) Set the retry counter to the specified value.Sets the idle time to a specific unix time (in milliseconds).
-
Method Details
-
minIdle
Set the min-idle-time to limit the command to messages that have been idle for at at least the givenDuration
.- Parameters:
minIdleTime
- must not be null.- Returns:
- new instance of
RedisStreamCommands.XClaimOptions
.
-
minIdleMs
Set the min-idle-time to limit the command to messages that have been idle for at at least the given milliseconds.- Parameters:
millis
-- Returns:
- new instance of
RedisStreamCommands.XClaimOptions
.
-
idle
Set the idle time since last delivery of a message. To specify a specific point in time usetime(Instant)
.- Parameters:
idleTime
- idle time.- Returns:
this
.
-
time
Sets the idle time to a specific unix time (in milliseconds). To define a relative idle time useidle(Duration)
.- Parameters:
unixTime
- idle time.- Returns:
this
.
-
retryCount
Set the retry counter to the specified value.- Parameters:
retryCount
- can be null. If null no change to the retry counter will be made.- Returns:
- new instance of
RedisStreamCommands.XClaimOptions
.
-
force
Forces creation of a pending message entry in the PEL even if it does not already exist as long a the given stream record id is valid.- Returns:
- new instance of
RedisStreamCommands.XClaimOptions
.
-
getIds
Get theList
of ID.- Returns:
- never null.
-
getIdsAsStringArray
Get the ID array asstrings
.- Returns:
- never null.
-
getMinIdleTime
Get the min-idle-time.- Returns:
- never null.
-
getIdleTime
Get the IDLE ms time.- Returns:
- can be null.
-
getUnixTime
Get the TIME ms-unix-time- Returns:
-
getRetryCount
Get the RETRYCOUNT count.- Returns:
-
isForce
public boolean isForce()Get the FORCE flag.- Returns:
-