redis.clients.jedis.args

Enum StreamDeletionPolicy

java.lang.Object

java.lang.Enum<StreamDeletionPolicy>

redis.clients.jedis.args.StreamDeletionPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StreamDeletionPolicy>, Rawable

public enum StreamDeletionPolicy
extends java.lang.Enum<StreamDeletionPolicy>
implements Rawable

Deletion policy for stream commands that handle consumer group references. Used with XDELEX, XACKDEL, and enhanced XADD/XTRIM commands.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACKNOWLEDGED Only operates on entries that were read and acknowledged by all consumer groups.
DELETE_REFERENCES Removes all references to entries from all consumer groups' pending entry lists, effectively cleaning up all traces of the messages.
KEEP_REFERENCES Preserves existing references to entries in all consumer groups' PEL.

Method Summary

Modifier and Type	Method and Description
byte[]	getRaw() Get byte array.
static StreamDeletionPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StreamDeletionPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface redis.clients.jedis.args.Rawable

equals, hashCode

Enum Constant Detail

KEEP_REFERENCES

public static final StreamDeletionPolicy KEEP_REFERENCES

Preserves existing references to entries in all consumer groups' PEL. This is the default behavior similar to XDEL.

DELETE_REFERENCES

public static final StreamDeletionPolicy DELETE_REFERENCES

Removes all references to entries from all consumer groups' pending entry lists, effectively cleaning up all traces of the messages.

ACKNOWLEDGED

public static final StreamDeletionPolicy ACKNOWLEDGED

Only operates on entries that were read and acknowledged by all consumer groups.

Method Detail

values

public static StreamDeletionPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StreamDeletionPolicy c : StreamDeletionPolicy.values())
    System.out.println(c);

Returns:

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

valueOf

public static StreamDeletionPolicy valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getRaw

public byte[] getRaw()

Description copied from interface: Rawable

Get byte array.

Specified by:

getRaw in interface Rawable

Returns:

binary