Package org.springframework.data.redis.connection

Class RedisStreamCommands.XDelOptions

java.lang.Object

org.springframework.data.redis.connection.RedisStreamCommands.XDelOptions

Enclosing interface:

RedisStreamCommands

@NullMarked
public static class RedisStreamCommands.XDelOptions
extends Object

Additional options applicable for XDELEX and XACKDEL commands.

Since:

4.1

Author:

Viktoriya Kutsarova

Method Summary

Modifier and Type	Method	Description
static RedisStreamCommands.XDelOptions	defaults()	Create an RedisStreamCommands.XDelOptions instance with default options.
static RedisStreamCommands.XDelOptions	deletionPolicy(RedisStreamCommands.StreamDeletionPolicy deletionPolicy)	Set the deletion policy for the delete operation.
boolean	equals(@Nullable Object o)
RedisStreamCommands.StreamDeletionPolicy	getDeletionPolicy()
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Details

defaults

public static RedisStreamCommands.XDelOptions defaults()

Create an RedisStreamCommands.XDelOptions instance with default options.

This returns the default options for the XDELEX and XACKDEL commands with RedisStreamCommands.StreamDeletionPolicy.KEEP_REFERENCES as the deletion policy, which preserves existing references in consumer groups' PELs (similar to the behavior of XDEL).

Returns:

a default RedisStreamCommands.XDelOptions instance with RedisStreamCommands.StreamDeletionPolicy.KEEP_REFERENCES.

deletionPolicy

public static RedisStreamCommands.XDelOptions deletionPolicy(RedisStreamCommands.StreamDeletionPolicy deletionPolicy)

Set the deletion policy for the delete operation.

Parameters:

deletionPolicy - the deletion policy to apply.

Returns:

new instance of RedisStreamCommands.XDelOptions.

getDeletionPolicy

public RedisStreamCommands.StreamDeletionPolicy getDeletionPolicy()

Returns:

the deletion policy.

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object