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.

Since:

2.2

Author:

Mark Paluch, Christoph Strobl, Tugdual Grall, Dengliming, Mark John Moreno, jinkshower

See Also:

• Redis Documentation: XTRIM

Method Summary

Modifier and Type	Method	Description
ReactiveStreamCommands.TrimCommand	approximate()	Applies approximate trimming.
ReactiveStreamCommands.TrimCommand	approximate(boolean approximateTrimming)	Applies approximateTrimming.
Long	getCount()
boolean	isApproximateTrimming()
static ReactiveStreamCommands.TrimCommand	stream(ByteBuffer key)	Creates a new ReactiveStreamCommands.TrimCommand given a key.
ReactiveStreamCommands.TrimCommand	to(long count)	Applies the numeric count.

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

public static ReactiveStreamCommands.TrimCommand stream(ByteBuffer key)

Creates a new ReactiveStreamCommands.TrimCommand given a key.

Parameters:

key - must not be null.

Returns:

a new ReactiveStreamCommands.TrimCommand for key.

to

public ReactiveStreamCommands.TrimCommand to(long count)

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

Parameters:

count -

Returns:

a new ReactiveStreamCommands.TrimCommand with count applied.

approximate

public ReactiveStreamCommands.TrimCommand 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

public ReactiveStreamCommands.TrimCommand approximate(boolean approximateTrimming)

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

getCount

@Nullable
public Long getCount()

Returns:

can be null.

isApproximateTrimming

public boolean isApproximateTrimming()