public class KeyScanArgs extends ScanArgs
SCAN
command. Static import the methods from
KeyScanArgs.Builder
and chain the method calls: type("string").limit(2)
.
KeyScanArgs
is a mutable object and instances should be used only once to avoid shared mutable state.
Modifier and Type | Class and Description |
---|---|
static class |
KeyScanArgs.Builder |
Constructor and Description |
---|
KeyScanArgs() |
Modifier and Type | Method and Description |
---|---|
<K,V> void |
build(CommandArgs<K,V> args)
Build command arguments and contribute arguments to
CommandArgs . |
KeyScanArgs |
limit(long count)
Limit the scan by count
|
KeyScanArgs |
match(String match)
Set the match filter.
|
KeyScanArgs |
match(String match,
Charset charset)
Set the match filter along the given
Charset . |
KeyScanArgs |
type(String type)
Return keys only of specified type.
|
public KeyScanArgs type(String type)
type
- of keys as returned by TYPE commandKeyScanArgs
.public KeyScanArgs match(String match)
UTF-8
to encode match
.public KeyScanArgs match(String match, Charset charset)
Charset
.public KeyScanArgs limit(long count)
public <K,V> void build(CommandArgs<K,V> args)
CompositeArgument
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.
build
in interface CompositeArgument
build
in class ScanArgs
K
- Key type.V
- Value type.args
- the command arguments, must not be null
.Copyright © 2021 lettuce.io. All rights reserved.