io.lettuce.core.models.stream

Enum StreamEntryDeletionResult

java.lang.Object

java.lang.Enum<StreamEntryDeletionResult>

io.lettuce.core.models.stream.StreamEntryDeletionResult

All Implemented Interfaces:

Serializable, Comparable<StreamEntryDeletionResult>

public enum StreamEntryDeletionResult
extends Enum<StreamEntryDeletionResult>

Result of stream entry deletion operations for XDELEX and XACKDEL commands.

Represents the outcome of attempting to delete a specific stream entry:

• NOT_FOUND (-1): ID doesn't exist in stream
• DELETED (1): Entry was deleted/acknowledged and deleted
• NOT_DELETED_UNACKNOWLEDGED_OR_STILL_REFERENCED (2): Entry wasn't deleted.

Since:

6.8

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELETED The entry was successfully deleted from the stream.
NOT_DELETED_UNACKNOWLEDGED_OR_STILL_REFERENCED The entry was not deleted due to one of the following reasons: For XDELEX: The entry was not acknowledged by any consumer group For XACKDEL: The entry still has pending references in other consumer groups
NOT_FOUND The stream entry ID was not found in the stream.
UNKNOWN

Method Summary

Modifier and Type	Method and Description
static StreamEntryDeletionResult	fromCode(int code) Create a StreamEntryDeletionResult from its numeric code.
static StreamEntryDeletionResult	fromLong(Long value) Create a StreamEntryDeletionResult from a Long value.
int	getCode() Returns the numeric code associated with this result.
String	toString()
static StreamEntryDeletionResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static StreamEntryDeletionResult[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final StreamEntryDeletionResult UNKNOWN

NOT_FOUND

public static final StreamEntryDeletionResult NOT_FOUND

The stream entry ID was not found in the stream.

DELETED

public static final StreamEntryDeletionResult DELETED

The entry was successfully deleted from the stream.

NOT_DELETED_UNACKNOWLEDGED_OR_STILL_REFERENCED

public static final StreamEntryDeletionResult NOT_DELETED_UNACKNOWLEDGED_OR_STILL_REFERENCED

The entry was not deleted due to one of the following reasons:

• For XDELEX: The entry was not acknowledged by any consumer group
• For XACKDEL: The entry still has pending references in other consumer groups

Method Detail

values

public static StreamEntryDeletionResult[] 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 (StreamEntryDeletionResult c : StreamEntryDeletionResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static StreamEntryDeletionResult valueOf(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:

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

NullPointerException - if the argument is null

getCode

public int getCode()

Returns the numeric code associated with this result.

Returns:

the numeric code.

fromCode

public static StreamEntryDeletionResult fromCode(int code)

Create a StreamEntryDeletionResult from its numeric code.

Parameters:

code - the numeric code.

Returns:

the StreamEntryDeletionResult.

Throws:

IllegalArgumentException - if the code is unknown.

fromLong

public static StreamEntryDeletionResult fromLong(Long value)

Create a StreamEntryDeletionResult from a Long value.

Parameters:

value - the Long value, may be null.

Returns:

the StreamEntryDeletionResult, or null if the input is null.

Throws:

IllegalArgumentException - if the code is unknown.

toString

public String toString()

Overrides:

toString in class Enum<StreamEntryDeletionResult>