io.lettuce.core

Class SUnionCardArgs

java.lang.Object

io.lettuce.core.SUnionCardArgs

All Implemented Interfaces:

CompositeArgument

public class SUnionCardArgs
extends Object
implements CompositeArgument

Argument list builder for the Redis SUNIONCARD command. Static import the methods from SUnionCardArgs.Builder and chain the method calls: approx().limit(1000).

SUnionCardArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Since:

7.7

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SUnionCardArgs.Builder Builder entry points for SUnionCardArgs.

Constructor Summary

Constructors

Constructor and Description
SUnionCardArgs()

Method Summary

Modifier and Type	Method and Description
SUnionCardArgs	approx() Request an approximate cardinality computed using HyperLogLog instead of the exact cardinality.
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
SUnionCardArgs	limit(long limit) Set the maximum cardinality to return.

Methods inherited from class java.lang.Object

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

Constructor Detail

SUnionCardArgs

public SUnionCardArgs()

Method Detail

approx

public SUnionCardArgs approx()

Request an approximate cardinality computed using HyperLogLog instead of the exact cardinality.

Returns:

this SUnionCardArgs.

Since:

7.7

limit

public SUnionCardArgs limit(long limit)

Set the maximum cardinality to return. The server may stop the computation once the limit is reached.

Parameters:

limit - the maximum cardinality to return, must not be negative. 0 means no limit.

Returns:

this SUnionCardArgs.

Throws:

IllegalArgumentException - if limit is negative.

Since:

7.7

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.