io.lettuce.core

Class XAddArgs

java.lang.Object

io.lettuce.core.XAddArgs

public class XAddArgs
extends Object

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

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

Since:

5.1

Author:

Mark Paluch

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
XAddArgs()

Method Summary

Modifier and Type	Method and Description
XAddArgs	approximateTrimming() Apply efficient trimming for capped streams using the ~ flag.
XAddArgs	approximateTrimming(boolean approximateTrimming) Apply efficient trimming for capped streams using the ~ flag.
<K,V> void	build(CommandArgs<K,V> args)
XAddArgs	id(String id) Limit results to maxlen entries.
XAddArgs	maxlen(long maxlen) Limit stream to maxlen entries.

Methods inherited from class java.lang.Object

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

Constructor Detail

XAddArgs

public XAddArgs()

Method Detail

id

public XAddArgs id(String id)

Limit results to maxlen entries.

Parameters:

id - must not be null.

Returns:

this

maxlen

public XAddArgs maxlen(long maxlen)

Limit stream to maxlen entries.

Parameters:

maxlen - number greater 0.

Returns:

this

approximateTrimming

public XAddArgs approximateTrimming()

Apply efficient trimming for capped streams using the ~ flag.

Returns:

this

approximateTrimming

public XAddArgs approximateTrimming(boolean approximateTrimming)

Apply efficient trimming for capped streams using the ~ flag.

Parameters:

approximateTrimming - true to apply efficient radix node trimming.

Returns:

this

build

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