io.lettuce.core.probabilistic.arguments

Class TopKReserveArgs

java.lang.Object

io.lettuce.core.probabilistic.arguments.TopKReserveArgs

All Implemented Interfaces:

CompositeArgument

public class TopKReserveArgs
extends Object
implements CompositeArgument

Argument list builder for the Redis TOPK.RESERVE command.

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

Since:

7.7

Author:

Yordan Tsintsov

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
TopKReserveArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
TopKReserveArgs	decay(double decay) Sets the decay of the filter.
TopKReserveArgs	depth(long depth) Sets the depth of the filter.
TopKReserveArgs	width(long width) Sets the width of the filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

TopKReserveArgs

public TopKReserveArgs()

Method Detail

width

public TopKReserveArgs width(long width)

Sets the width of the filter.

Parameters:

width - the width of the filter

Returns:

this TopKReserveArgs

depth

public TopKReserveArgs depth(long depth)

Sets the depth of the filter.

Parameters:

depth - the depth of the filter

Returns:

this TopKReserveArgs

decay

public TopKReserveArgs decay(double decay)

Sets the decay of the filter.

Parameters:

decay - the decay of the filter

Returns:

this TopKReserveArgs

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.