XAddArgs (Lettuce 7.5.2.RELEASE API)

java.lang.Object
- io.lettuce.core.XAddArgs

All Implemented Interfaces:

CompositeArgument
```
public class XAddArgs
extends Object
implements CompositeArgument
```
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, dengliming

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class XAddArgs.Builder
Builder entry points for XAddArgs.

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

Constructor Summary

Constructors
Constructor and Description

XAddArgs()

Constructors
Constructor and Description
`XAddArgs()`

Method Summary

All Methods Instance Methods Concrete Methods
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`	`idmp(byte[] producerId, byte[] idempotentId)` Enable idempotent producer mode with explicit idempotent ID.
`XAddArgs`	`idmp(String producerId, String idempotentId)` Enable idempotent producer mode with explicit idempotent ID.
`XAddArgs`	`idmpAuto(byte[] producerId)` Enable idempotent producer mode with auto-generated idempotent ID (content-based).
`XAddArgs`	`idmpAuto(String producerId)` Enable idempotent producer mode with auto-generated idempotent ID (content-based).
`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.
`XAddArgs`	`trimmingMode(StreamDeletionPolicy trimmingMode)` When trimming, defines desired behaviour for handling consumer group references.

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)
```
    Specify the message id.
    
    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
  - minId
```
public XAddArgs minId(String minid)
```
    Limit stream entries by message Id.
    
    Parameters:
    
    minid - the oldest ID in the stream will be exactly the minimum between its original oldest ID and the specified threshold.
    
    Returns:
    
    this
    
    Since:
    
    6.1
  - limit
```
public XAddArgs limit(long limit)
```
    The maximum number of entries to trim.
    
    Parameters:
    
    limit - has meaning only if `~` was set.
    
    Returns:
    
    this
    
    Since:
    
    6.1
  - trimmingMode
```
public XAddArgs trimmingMode(StreamDeletionPolicy trimmingMode)
```
    When trimming, defines desired behaviour for handling consumer group references. See StreamDeletionPolicy for details.
    
    Parameters:
    
    trimmingMode - the deletion policy to apply during trimming.
    
    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
  - exactTrimming
```
public XAddArgs exactTrimming()
```
    Apply exact trimming for capped streams using the = flag.
    
    Returns:
    
    this
    
    Since:
    
    6.1
  - exactTrimming
```
public XAddArgs exactTrimming(boolean exactTrimming)
```
    Apply exact trimming for capped streams using the = flag.
    
    Parameters:
    
    exactTrimming - true to apply exact radix node trimming.
    
    Returns:
    
    this
    
    Since:
    
    6.1
  - nomkstream
```
public XAddArgs nomkstream()
```
    Do add the message if the stream does not already exist.
    
    Returns:
    
    this
    
    Since:
    
    6.1
  - nomkstream
```
public XAddArgs nomkstream(boolean nomkstream)
```
    Do add the message if the stream does not already exist.
    
    Parameters:
    
    nomkstream - true to not create a stream if it does not already exist.
    
    Returns:
    
    this
    
    Since:
    
    6.1
  - idmp
```
public XAddArgs idmp(byte[] producerId,
                     byte[] idempotentId)
```
    Enable idempotent producer mode with explicit idempotent ID.
    
    Parameters:
    
    producerId - the producer ID (must be unique per producer and consistent across restarts).
    
    idempotentId - the idempotent ID (must be unique per message and consistent across resends).
    
    Returns:
    
    this
  - idmp
```
public XAddArgs idmp(String producerId,
                     String idempotentId)
```
    Enable idempotent producer mode with explicit idempotent ID.
    
    Parameters:
    
    producerId - the producer ID (must be unique per producer and consistent across restarts).
    
    idempotentId - the idempotent ID (must be unique per message and consistent across resends).
    
    Returns:
    
    this
  - idmpAuto
```
public XAddArgs idmpAuto(byte[] producerId)
```
    Enable idempotent producer mode with auto-generated idempotent ID (content-based).
    
    Parameters:
    
    producerId - the producer ID (must be unique per producer and consistent across restarts).
    
    Returns:
    
    this
  - idmpAuto
```
public XAddArgs idmpAuto(String producerId)
```
    Enable idempotent producer mode with auto-generated idempotent ID (content-based).
    
    Parameters:
    
    producerId - the producer ID (must be unique per producer and consistent across restarts).
    
    Returns:
    
    this
  - 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.

Class XAddArgs

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XAddArgs

Method Detail

id

maxlen

minId

limit

trimmingMode

approximateTrimming

approximateTrimming

exactTrimming

exactTrimming

nomkstream

nomkstream

idmp

idmp

idmpAuto

idmpAuto

build