Package io.lettuce.core
Class XGroupCreateArgs
- java.lang.Object
-
- io.lettuce.core.XGroupCreateArgs
-
- All Implemented Interfaces:
CompositeArgument
public class XGroupCreateArgs extends Object implements CompositeArgument
Argument list builder for the Redis XGROUP CREATE command. Static import the methods fromXGroupCreateArgs.Builder
and call the methods:mkstream(…)
.XGroupCreateArgs
is a mutable object and instances should be used only once to avoid shared mutable state.- Since:
- 5.2
- Author:
- Mark Paluch
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
XGroupCreateArgs.Builder
Builder entry points forXGroupCreateArgs
.
-
Constructor Summary
Constructors Constructor Description XGroupCreateArgs()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <K,V>
voidbuild(CommandArgs<K,V> args)
Build command arguments and contribute arguments toCommandArgs
.XGroupCreateArgs
entriesRead(long entriesRead)
Configure the ENTRIESREAD argument.XGroupCreateArgs
mkstream(boolean mkstream)
Make a stream if it does not exists.
-
-
-
Method Detail
-
mkstream
public XGroupCreateArgs mkstream(boolean mkstream)
Make a stream if it does not exists.- Parameters:
mkstream
- whether to apply MKSTREAM- Returns:
this
-
entriesRead
public XGroupCreateArgs entriesRead(long entriesRead)
Configure the ENTRIESREAD argument.- Parameters:
entriesRead
- number of read entries for lag tracking.- Returns:
this
- Since:
- 6.2
-
build
public <K,V> void build(CommandArgs<K,V> args)
Description copied from interface:CompositeArgument
Build command arguments and contribute arguments toCommandArgs
.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 interfaceCompositeArgument
- Type Parameters:
K
- Key type.V
- Value type.- Parameters:
args
- the command arguments, must not benull
.
-
-