Class RedisStreamCommands.XClaimOptions

java.lang.Object

org.springframework.data.redis.connection.RedisStreamCommands.XClaimOptions

Enclosing interface:

RedisStreamCommands

@NullMarked
public static class RedisStreamCommands.XClaimOptions
extends Object

Since:

2.3

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RedisStreamCommands.XClaimOptions.XClaimOptionsBuilder

Method Summary

Modifier and Type	Method	Description
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.
@Nullable Duration	getIdleTime()	Get the IDLE ms time.
List<RecordId>	getIds()	Get the List of ID.
String[]	getIdsAsStringArray()	Get the ID array as strings.
Duration	getMinIdleTime()	Get the min-idle-time.
@Nullable Long	getRetryCount()	Get the RETRYCOUNT count.
@Nullable Instant	getUnixTime()	Get the TIME ms-unix-time
RedisStreamCommands.XClaimOptions	idle(Duration idleTime)	Set the idle time since last delivery of a message.
boolean	isForce()	Get the FORCE flag.
static RedisStreamCommands.XClaimOptions.XClaimOptionsBuilder	minIdle(Duration minIdleTime)	Set the min-idle-time to limit the command to messages that have been idle for at least the given Duration.
static RedisStreamCommands.XClaimOptions.XClaimOptionsBuilder	minIdleMs(long millis)	Set the min-idle-time to limit the command to messages that have been idle for at least the given milliseconds.
RedisStreamCommands.XClaimOptions	retryCount(long retryCount)	Set the retry counter to the specified value.
RedisStreamCommands.XClaimOptions	time(Instant unixTime)	Sets the idle time to a specific unix time (in milliseconds).

Methods inherited from class Object

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

Method Details

minIdle

public static RedisStreamCommands.XClaimOptions.XClaimOptionsBuilder minIdle(Duration minIdleTime)

Set the min-idle-time to limit the command to messages that have been idle for at least the given Duration.

Parameters:

minIdleTime - must not be null.

Returns:

new instance of RedisStreamCommands.XClaimOptions.

minIdleMs

public static RedisStreamCommands.XClaimOptions.XClaimOptionsBuilder minIdleMs(long millis)

Set the min-idle-time to limit the command to messages that have been idle for at least the given milliseconds.

Parameters:

millis -

Returns:

new instance of RedisStreamCommands.XClaimOptions.

idle

public RedisStreamCommands.XClaimOptions idle(Duration idleTime)

Set the idle time since last delivery of a message. To specify a specific point in time use time(Instant).

Parameters:

idleTime - idle time.

Returns:

this.

time

public RedisStreamCommands.XClaimOptions time(Instant unixTime)

Sets the idle time to a specific unix time (in milliseconds). To define a relative idle time use idle(Duration).

Parameters:

unixTime - idle time.

Returns:

this.

retryCount

public RedisStreamCommands.XClaimOptions retryCount(long retryCount)

Set the retry counter to the specified value.

Parameters:

retryCount - the retry counter value to set.

Returns:

new instance of RedisStreamCommands.XClaimOptions.

force

public 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

public List<RecordId> getIds()

Get the List of ID.

Returns:

never null.

getIdsAsStringArray

public String[] getIdsAsStringArray()

Get the ID array as strings.

Returns:

never null.

getMinIdleTime

public Duration getMinIdleTime()

Get the min-idle-time.

Returns:

never null.

getIdleTime

public @Nullable Duration getIdleTime()

Get the IDLE ms time.

Returns:

can be null.

getUnixTime

public @Nullable Instant getUnixTime()

Get the TIME ms-unix-time

Returns:

getRetryCount

public @Nullable Long getRetryCount()

Get the RETRYCOUNT count.

Returns:

isForce

public boolean isForce()

Get the FORCE flag.

Returns: