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 from XGroupCreateArgs.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 and Description
static class	XGroupCreateArgs.Builder Builder entry points for XGroupCreateArgs.

Constructor Summary

Constructors

Constructor and Description
XGroupCreateArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
XGroupCreateArgs	entriesRead(long entriesRead) Configure the ENTRIESREAD argument.
XGroupCreateArgs	mkstream(boolean mkstream) Make a stream if it does not exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

XGroupCreateArgs

public XGroupCreateArgs()

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 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.