Package glide.api.models.commands.stream

Class StreamTrimOptions

java.lang.Object

glide.api.models.commands.stream.StreamTrimOptions

Direct Known Subclasses:

StreamTrimOptions.MaxLen, StreamTrimOptions.MinId

public abstract class StreamTrimOptions
extends java.lang.Object

Optional arguments for StreamBaseCommands.xtrim(String, StreamTrimOptions)

See Also:

valkey.io

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StreamTrimOptions.MaxLen	Option to trim the stream according to maximum stream length.
static class	StreamTrimOptions.MinId	Option to trim the stream according to minimum ID.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.Boolean	exact	If true, the stream will be trimmed exactly.
protected java.lang.Long	limit	If set, sets the maximal amount of entries that will be deleted.
static java.lang.String	TRIM_EXACT_VALKEY_API
static java.lang.String	TRIM_LIMIT_VALKEY_API
static java.lang.String	TRIM_MAXLEN_VALKEY_API
static java.lang.String	TRIM_MINID_VALKEY_API
static java.lang.String	TRIM_NOT_EXACT_VALKEY_API

Constructor Summary

Constructors

Constructor	Description
StreamTrimOptions()

Method Summary

Modifier and Type	Method	Description
protected abstract java.lang.String	getMethod()
protected abstract java.lang.String	getThreshold()
protected java.util.List<java.lang.String>	getValkeyApi()
java.lang.String[]	toArgs()	Converts options for StreamBaseCommands.xtrim(String, StreamTrimOptions) into a String[].
GlideString[]	toGlideStringArgs()	Converts options for StreamBaseCommands.xtrim(String, StreamTrimOptions) into a GlideString[].

Methods inherited from class java.lang.Object

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

Field Detail

TRIM_MAXLEN_VALKEY_API

public static final java.lang.String TRIM_MAXLEN_VALKEY_API

See Also:

Constant Field Values

TRIM_MINID_VALKEY_API

public static final java.lang.String TRIM_MINID_VALKEY_API

See Also:

Constant Field Values

TRIM_EXACT_VALKEY_API

public static final java.lang.String TRIM_EXACT_VALKEY_API

See Also:

Constant Field Values

TRIM_NOT_EXACT_VALKEY_API

public static final java.lang.String TRIM_NOT_EXACT_VALKEY_API

See Also:

Constant Field Values

TRIM_LIMIT_VALKEY_API

public static final java.lang.String TRIM_LIMIT_VALKEY_API

See Also:

Constant Field Values

exact

protected java.lang.Boolean exact

If true, the stream will be trimmed exactly. Equivalent to = in the Valkey API. Otherwise, the stream will be trimmed in a near-exact manner, which is more efficient, equivalent to ~ in the Valkey API.

limit

protected java.lang.Long limit

If set, sets the maximal amount of entries that will be deleted.

Constructor Detail

StreamTrimOptions

public StreamTrimOptions()

Method Detail

getMethod

protected abstract java.lang.String getMethod()

getThreshold

protected abstract java.lang.String getThreshold()

getValkeyApi

protected java.util.List<java.lang.String> getValkeyApi()

toArgs

public java.lang.String[] toArgs()

Converts options for StreamBaseCommands.xtrim(String, StreamTrimOptions) into a String[].

Returns:

String[]

toGlideStringArgs

public GlideString[] toGlideStringArgs()

Converts options for StreamBaseCommands.xtrim(String, StreamTrimOptions) into a GlideString[].

Returns:

GlideString[]