Package org.springframework.data.redis.connection

Class ReactiveStreamCommands.TrimCommand

java.lang.Object

org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand

org.springframework.data.redis.connection.ReactiveStreamCommands.TrimCommand

All Implemented Interfaces:

ReactiveRedisConnection.Command

Enclosing interface:

ReactiveStreamCommands

public static class ReactiveStreamCommands.TrimCommand
extends ReactiveRedisConnection.KeyCommand

XTRIM command parameters.

See Also:

• Redis Documentation: XTRIM

Method Summary

Modifier and Type	Method	Description
ReactiveStreamCommands.TrimCommand	approximate()	Deprecated. since 4.0: do not toggle the trim operator in isolation.
ReactiveStreamCommands.TrimCommand	approximate(boolean approximateTrimming)	Deprecated. since 4.0: do not toggle the trim operator in isolation.
@Nullable Long	getCount()	Deprecated. since 4.0: Inspect getOptions() -> RedisStreamCommands.XTrimOptions.getTrimOptions() -> RedisStreamCommands.TrimOptions.getTrimStrategy() and obtain the threshold from the concrete strategy instead.
RedisStreamCommands.XTrimOptions	getOptions()
boolean	isApproximateTrimming()
ReactiveStreamCommands.TrimCommand	options(RedisStreamCommands.XTrimOptions options)	Apply the given RedisStreamCommands.XTrimOptions to configure the XTRIM command.
static ReactiveStreamCommands.TrimCommand	stream(ByteBuffer key)	Deprecated. since 4.0, prefer stream(ByteBuffer, XTrimOptions) instead.
static ReactiveStreamCommands.TrimCommand	stream(ByteBuffer key, RedisStreamCommands.XTrimOptions options)	Creates a new ReactiveStreamCommands.TrimCommand given a key and RedisStreamCommands.XTrimOptions.
ReactiveStreamCommands.TrimCommand	to(long threshold)	Deprecated. since 4.0: specify a concrete trim strategy (MAXLEN or MINID) via RedisStreamCommands.XTrimOptions and RedisStreamCommands.TrimOptions instead of using this method.

Methods inherited from class org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand

getKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.redis.connection.ReactiveRedisConnection.Command

getName

Method Details

stream

@Deprecated(since="4.0",
            forRemoval=false)
public static ReactiveStreamCommands.TrimCommand stream(ByteBuffer key)

Deprecated.

since 4.0, prefer stream(ByteBuffer, XTrimOptions) instead.

Creates a new ReactiveStreamCommands.TrimCommand given a key.

Parameters:

key - must not be null.

Returns:

a new ReactiveStreamCommands.TrimCommand for key.

Since:

4.0

stream

public static ReactiveStreamCommands.TrimCommand stream(ByteBuffer key,
 RedisStreamCommands.XTrimOptions options)

Creates a new ReactiveStreamCommands.TrimCommand given a key and RedisStreamCommands.XTrimOptions.

Parameters:

key - must not be null.

options - must not be null.

Returns:

a new ReactiveStreamCommands.TrimCommand for key.

Since:

4.0

to

@Deprecated(since="4.0",
            forRemoval=false)
public ReactiveStreamCommands.TrimCommand to(long threshold)

Deprecated.

since 4.0: specify a concrete trim strategy (MAXLEN or MINID) via RedisStreamCommands.XTrimOptions and RedisStreamCommands.TrimOptions instead of using this method. Prefer options(XTrimOptions.trim(TrimOptions.maxLen(threshold))) or construct with stream(key, XTrimOptions.trim(TrimOptions.maxLen(threshold))).

Applies the numeric threshold. Constructs a new command instance with all previously configured properties.

Parameters:

threshold -

Returns:

a new ReactiveStreamCommands.TrimCommand with threshold applied.

approximate

@Deprecated(since="4.0",
            forRemoval=false)
public ReactiveStreamCommands.TrimCommand approximate()

Deprecated.

since 4.0: do not toggle the trim operator in isolation. Specify a concrete trim strategy (MAXLEN or MINID) and operator via RedisStreamCommands.XTrimOptions and RedisStreamCommands.TrimOptions, e.g. options(XTrimOptions.trim(TrimOptions.maxLen(n).approximate())).

Applies approximate trimming. Constructs a new command instance with all previously configured properties.

Returns:

a new ReactiveStreamCommands.TrimCommand with approximateTrimming applied.

Since:

2.4

approximate

@Deprecated(since="4.0",
            forRemoval=false)
public ReactiveStreamCommands.TrimCommand approximate(boolean approximateTrimming)

Deprecated.

since 4.0: do not toggle the trim operator in isolation. Specify a concrete trim strategy (MAXLEN or MINID) and operator via RedisStreamCommands.XTrimOptions and RedisStreamCommands.TrimOptions, e.g. options(XTrimOptions.trim(TrimOptions.maxLen(n).approximate())) or options(XTrimOptions.trim(TrimOptions.minId(id).exact())).

Applies approximateTrimming. Constructs a new command instance with all previously configured properties.

Parameters:

approximateTrimming -

Returns:

a new ReactiveStreamCommands.TrimCommand with approximateTrimming applied.

Since:

2.4

options

public ReactiveStreamCommands.TrimCommand options(RedisStreamCommands.XTrimOptions options)

Apply the given RedisStreamCommands.XTrimOptions to configure the XTRIM command.

This method allows setting all XTRIM options at once, including trimming strategies (MAXLEN, MINID) and other parameters. Constructs a new command instance with all previously configured properties except the options, which are replaced by the provided RedisStreamCommands.XTrimOptions.

Parameters:

options - the RedisStreamCommands.XTrimOptions to apply. Must not be null.

Returns:

a new ReactiveStreamCommands.TrimCommand with the specified options applied.

Since:

4.1

getCount

@Deprecated(since="4.0",
            forRemoval=false)
public @Nullable Long getCount()

Deprecated.

since 4.0: Inspect getOptions() -> RedisStreamCommands.XTrimOptions.getTrimOptions() -> RedisStreamCommands.TrimOptions.getTrimStrategy() and obtain the threshold from the concrete strategy instead. For example: if (strategy instanceof MaxLenTrimStrategy m) { m.threshold(); } or if (strategy instanceof MinIdTrimStrategy i) { i.threshold(); }.

Returns the MAXLEN threshold if the active trim strategy is MAXLEN; otherwise null.

Returns:

can be null.

isApproximateTrimming

public boolean isApproximateTrimming()

getOptions

public RedisStreamCommands.XTrimOptions getOptions()