Package org.springframework.data.redis.connection

Enum Class RedisStreamCommands.StreamDeletionPolicy

java.lang.Object

java.lang.Enum<RedisStreamCommands.StreamDeletionPolicy>

org.springframework.data.redis.connection.RedisStreamCommands.StreamDeletionPolicy

All Implemented Interfaces:

Serializable, Comparable<RedisStreamCommands.StreamDeletionPolicy>, Constable

Enclosing interface:

RedisStreamCommands

public static enum RedisStreamCommands.StreamDeletionPolicy
extends Enum<RedisStreamCommands.StreamDeletionPolicy>

Deletion policy for stream entries - specifies how to handle consumer group references when deleting stream entries.

Since:

4.1

Author:

Viktoriya Kutsarova

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACKNOWLEDGED	Remove entries that meet the specified strategy and that have been read and acknowledged by all consumer groups.
DELETE_REFERENCES	Remove entries according to the specified strategy and remove all references to these entries from all consumer groups' PEL.
KEEP_REFERENCES	Remove entries according to the specified strategy, but preserve existing references to these entries in all consumer groups' PEL (Pending Entries List).

Method Summary

Modifier and Type	Method	Description
static RedisStreamCommands.StreamDeletionPolicy	delete()	Factory method for DELETE_REFERENCES.
static RedisStreamCommands.StreamDeletionPolicy	keep()	Factory method for KEEP_REFERENCES.
static RedisStreamCommands.StreamDeletionPolicy	removeAcknowledged()	Factory method for ACKNOWLEDGED.
static RedisStreamCommands.StreamDeletionPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RedisStreamCommands.StreamDeletionPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

KEEP_REFERENCES

public static final RedisStreamCommands.StreamDeletionPolicy KEEP_REFERENCES

Remove entries according to the specified strategy, but preserve existing references to these entries in all consumer groups' PEL (Pending Entries List).

DELETE_REFERENCES

public static final RedisStreamCommands.StreamDeletionPolicy DELETE_REFERENCES

Remove entries according to the specified strategy and remove all references to these entries from all consumer groups' PEL.

ACKNOWLEDGED

public static final RedisStreamCommands.StreamDeletionPolicy ACKNOWLEDGED

Remove entries that meet the specified strategy and that have been read and acknowledged by all consumer groups.

Method Details

values

public static RedisStreamCommands.StreamDeletionPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RedisStreamCommands.StreamDeletionPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

keep

public static RedisStreamCommands.StreamDeletionPolicy keep()

Factory method for KEEP_REFERENCES.

delete

public static RedisStreamCommands.StreamDeletionPolicy delete()

Factory method for DELETE_REFERENCES.

removeAcknowledged

public static RedisStreamCommands.StreamDeletionPolicy removeAcknowledged()

Factory method for ACKNOWLEDGED.