public class XAddArgs extends Object implements CompositeArgument
XAddArgs.Builder
and call the methods: maxlen(…)
.
XAddArgs
is a mutable object and instances should be used only once to avoid shared mutable state.
Modifier and Type | Class and Description |
---|---|
static class |
XAddArgs.Builder
Builder entry points for
XAddArgs . |
Constructor and Description |
---|
XAddArgs() |
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)
Build command arguments and contribute arguments to
CommandArgs . |
XAddArgs |
exactTrimming()
Apply exact trimming for capped streams using the
= flag. |
XAddArgs |
exactTrimming(boolean exactTrimming)
Apply exact trimming for capped streams using the
= flag. |
XAddArgs |
id(String id)
Specify the message
id . |
XAddArgs |
limit(long limit)
The maximum number of entries to trim.
|
XAddArgs |
maxlen(long maxlen)
Limit stream to
maxlen entries. |
XAddArgs |
minId(String minid)
Limit stream entries by message Id.
|
XAddArgs |
nomkstream()
Do add the message if the stream does not already exist.
|
XAddArgs |
nomkstream(boolean nomkstream)
Do add the message if the stream does not already exist.
|
public XAddArgs id(String id)
id
.id
- must not be null
.this
public XAddArgs maxlen(long maxlen)
maxlen
entries.maxlen
- number greater 0.this
public XAddArgs minId(String minid)
minid
- the oldest ID in the stream will be exactly the minimum between its original oldest ID and the specified
threshold.this
public XAddArgs limit(long limit)
limit
- has meaning only if `~`
was set.this
public XAddArgs approximateTrimming()
~
flag.this
public XAddArgs approximateTrimming(boolean approximateTrimming)
~
flag.approximateTrimming
- true
to apply efficient radix node trimming.this
public XAddArgs exactTrimming()
=
flag.this
public XAddArgs exactTrimming(boolean exactTrimming)
=
flag.exactTrimming
- true
to apply exact radix node trimming.this
public XAddArgs nomkstream()
this
public XAddArgs nomkstream(boolean nomkstream)
nomkstream
- true
to not create a stream if it does not already exist.this
public <K,V> void build(CommandArgs<K,V> args)
CompositeArgument
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.
build
in interface CompositeArgument
K
- Key type.V
- Value type.args
- the command arguments, must not be null
.Copyright © 2024 lettuce.io. All rights reserved.