io.lettuce.core

Class XTrimArgs

java.lang.Object

io.lettuce.core.XTrimArgs

All Implemented Interfaces:

CompositeArgument

public class XTrimArgs
extends Object
implements CompositeArgument

Argument list builder for the Redis XTRIM command. Static import the methods from XTrimArgs.Builder and call the methods: maxlen(…) .

XTrimArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Since:

6.1

Author:

dengliming

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XTrimArgs.Builder Builder entry points for XTrimArgs.

Constructor Summary

Constructors

Constructor and Description
XTrimArgs()

Method Summary

Modifier and Type	Method and Description
XTrimArgs	approximateTrimming() Apply efficient trimming for capped streams using the ~ flag.
XTrimArgs	approximateTrimming(boolean approximateTrimming) Apply efficient trimming for capped streams using the ~ flag.
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
XTrimArgs	exactTrimming() Apply exact trimming for capped streams using the = flag.
XTrimArgs	exactTrimming(boolean exactTrimming) Apply exact trimming for capped streams using the = flag.
XTrimArgs	limit(long limit) The maximum number of entries to trim.
XTrimArgs	maxlen(long maxlen) Limit stream to maxlen entries.
XTrimArgs	minId(String minid) Limit stream entries by message Id.

Methods inherited from class java.lang.Object

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

Constructor Detail

XTrimArgs

public XTrimArgs()

Method Detail

maxlen

public XTrimArgs maxlen(long maxlen)

Limit stream to maxlen entries.

Parameters:

maxlen - number greater 0.

Returns:

this

minId

public XTrimArgs minId(String minid)

Limit stream entries by message Id.

Parameters:

minid - the oldest ID in the stream will be exactly the minimum between its original oldest ID and the specified threshold.

Returns:

this

limit

public XTrimArgs limit(long limit)

The maximum number of entries to trim.

Parameters:

limit - has meaning only if `~` was set.

Returns:

this

approximateTrimming

public XTrimArgs approximateTrimming()

Apply efficient trimming for capped streams using the ~ flag.

Returns:

this

approximateTrimming

public XTrimArgs approximateTrimming(boolean approximateTrimming)

Apply efficient trimming for capped streams using the ~ flag.

Parameters:

approximateTrimming - true to apply efficient radix node trimming.

Returns:

this

exactTrimming

public XTrimArgs exactTrimming()

Apply exact trimming for capped streams using the = flag.

Returns:

this

exactTrimming

public XTrimArgs exactTrimming(boolean exactTrimming)

Apply exact trimming for capped streams using the = flag.

Parameters:

exactTrimming - true to apply exact radix node trimming.

Returns:

this

build

public <K,V> void build(CommandArgs<K,V> args)

Description copied from interface: CompositeArgument

Build command arguments and contribute arguments to CommandArgs.

Implementing classes are required to implement this method. Depending on the command nature and configured arguments, this method may contribute arguments but is not required to add arguments if none are specified.

Specified by:

build in interface CompositeArgument

Type Parameters:

K - Key type.

V - Value type.

Parameters:

args - the command arguments, must not be null.