Package io.quarkus.redis.datasource.stream

Class XGroupCreateArgs

java.lang.Object

io.quarkus.redis.datasource.stream.XGroupCreateArgs

All Implemented Interfaces:

RedisCommandExtraArguments

public class XGroupCreateArgs
extends Object
implements RedisCommandExtraArguments

Represents the extra argument of the <a href="https://redis.io/commands/xgroup-create/>XGROUP CREATE command.

Constructor Summary

Constructors

Constructor	Description
XGroupCreateArgs()

Method Summary

Modifier and Type	Method	Description
XGroupCreateArgs	entriesRead(String id)	To enable consumer group lag tracking, specify the optional entries_read named argument with an arbitrary ID.
XGroupCreateArgs	mkstream()	If a stream does not exist, you can create it automatically with length of 0.
List<Object>	toArgs()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.quarkus.redis.datasource.RedisCommandExtraArguments

toArgs

Constructor Details

XGroupCreateArgs

public XGroupCreateArgs()

Method Details

mkstream

public XGroupCreateArgs mkstream()

If a stream does not exist, you can create it automatically with length of 0.

Returns:

the current XGroupCreateArgs

entriesRead

public XGroupCreateArgs entriesRead(String id)

To enable consumer group lag tracking, specify the optional entries_read named argument with an arbitrary ID. An arbitrary ID is any ID that isn't the ID of the stream's first entry, last entry, or zero ("0-0") ID. Use it to find out how many entries are between the arbitrary ID (excluding it) and the stream's last entry. Set the entries_read the stream's entries_added subtracted by the number of entries.

Requires REdis 7.0.0+

Parameters:

id - the arbitrary id

Returns:

the current XGroupCreateArgs

toArgs

public List<Object> toArgs()

Specified by:

toArgs in interface RedisCommandExtraArguments

Returns:

the list of arguments.