Class RedisStreamCommands.TrimOptions

java.lang.Object

org.springframework.data.redis.connection.RedisStreamCommands.TrimOptions

Enclosing interface:

RedisStreamCommands

@NullMarked
public static class RedisStreamCommands.TrimOptions
extends Object

Since:

2.2

Author:

Mark Paluch, Christoph Strobl, Tugdual Grall, Dengliming, Mark John Moreno, Jeonggyu Choi, Viktoriya Kutsarova

Method Summary

Modifier and Type	Method	Description
RedisStreamCommands.TrimOptions	approximate()	Use approximate trimming ("~").
RedisStreamCommands.TrimOptions	deletionPolicy(RedisStreamCommands.StreamDeletionPolicy deletionPolicy)	Set the deletion policy for trimming.
boolean	equals(@Nullable Object o)
RedisStreamCommands.TrimOptions	exact()	Use exact trimming ("=").
@Nullable RedisStreamCommands.StreamDeletionPolicy	getDeletionPolicy()
@Nullable Long	getLimit()
RedisStreamCommands.TrimOperator	getTrimOperator()
RedisStreamCommands.TrimStrategy	getTrimStrategy()
boolean	hasDeletionPolicy()
int	hashCode()
boolean	hasLimit()
RedisStreamCommands.TrimOptions	limit(long limit)	Limit the maximum number of entries considered when trimming.
static RedisStreamCommands.TrimOptions	maxLen(long maxLen)	Create trim options using the MAXLEN strategy with the given threshold.
static RedisStreamCommands.TrimOptions	minId(RecordId minId)	Create trim options using the MINID strategy with the given minimum id.
RedisStreamCommands.TrimOptions	trim(RedisStreamCommands.TrimOperator trimOperator)	Apply specified trim operator.

Methods inherited from class Object

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

Method Details

maxLen

public static RedisStreamCommands.TrimOptions maxLen(long maxLen)

Create trim options using the MAXLEN strategy with the given threshold.

Produces RedisStreamCommands.TrimOptions with the exact ("=") operator by default; call approximate() to use approximate ("~") trimming.

Parameters:

maxLen - maximum number of entries to retain in the stream

Returns:

new RedisStreamCommands.TrimOptions configured with the MAXLEN strategy

Since:

4.0

minId

public static RedisStreamCommands.TrimOptions minId(RecordId minId)

Create trim options using the MINID strategy with the given minimum id.

Produces RedisStreamCommands.TrimOptions with the exact ("=") operator by default; call approximate() to use approximate ("~") trimming.

Parameters:

minId - minimum id; entries with an id lower than this value are eligible for trimming

Returns:

new RedisStreamCommands.TrimOptions configured with the MINID strategy

Since:

4.0

trim

public RedisStreamCommands.TrimOptions trim(RedisStreamCommands.TrimOperator trimOperator)

Apply specified trim operator.

This is a member method that preserves all other options.

Parameters:

trimOperator - the operator to use when trimming

Returns:

new instance of RedisStreamCommands.XTrimOptions.

approximate

public RedisStreamCommands.TrimOptions approximate()

Use approximate trimming ("~").

This is a member method that preserves all other options.

Returns:

new instance of RedisStreamCommands.TrimOptions with RedisStreamCommands.TrimOperator.APPROXIMATE.

exact

public RedisStreamCommands.TrimOptions exact()

Use exact trimming ("=").

This is a member method that preserves all other options.

Returns:

new instance of RedisStreamCommands.TrimOptions with RedisStreamCommands.TrimOperator.EXACT.

limit

public RedisStreamCommands.TrimOptions limit(long limit)

Limit the maximum number of entries considered when trimming.

This is a member method that preserves all other options.

Parameters:

limit - the maximum number of entries to examine for trimming.

Returns:

new instance of RedisStreamCommands.XTrimOptions.

deletionPolicy

public RedisStreamCommands.TrimOptions deletionPolicy(RedisStreamCommands.StreamDeletionPolicy deletionPolicy)

Set the deletion policy for trimming.

This is a member method that preserves all other options.

Parameters:

deletionPolicy - the deletion policy to apply.

Returns:

new instance of RedisStreamCommands.XTrimOptions.

getTrimStrategy

public RedisStreamCommands.TrimStrategy getTrimStrategy()

getTrimOperator

public RedisStreamCommands.TrimOperator getTrimOperator()

Returns:

strategy to use when trimming entries

getLimit

public @Nullable Long getLimit()

Returns:

the limit to retain during trimming.

Since:

4.0

hasLimit

public boolean hasLimit()

Returns:

true if LIMIT is set.

Since:

4.0

getDeletionPolicy

public @Nullable RedisStreamCommands.StreamDeletionPolicy getDeletionPolicy()

Returns:

the deletion policy.

Since:

4.0

hasDeletionPolicy

public boolean hasDeletionPolicy()

Returns:

true if DELETION_POLICY is set.

Since:

4.0

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object