Package org.springframework.data.redis.connection

Class ReactiveRedisConnection.KeyScanCommand

java.lang.Object

org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand

org.springframework.data.redis.connection.ReactiveRedisConnection.KeyScanCommand

All Implemented Interfaces:

ReactiveRedisConnection.Command

Enclosing interface:

ReactiveRedisConnection

public static class ReactiveRedisConnection.KeyScanCommand
extends ReactiveRedisConnection.KeyCommand

ReactiveRedisConnection.Command for key-bound scan operations like SCAN, HSCAN, SSCAN and ZSCAN.

Since:

2.1

Author:

Mark Paluch, Christoph Strobl

Method Summary

Modifier and Type	Method	Description
ScanOptions	getOptions()	Get the ScanOptions to apply.
static ReactiveRedisConnection.KeyScanCommand	key(ByteBuffer key)	Creates a new ReactiveRedisConnection.KeyScanCommand given a key.
ReactiveRedisConnection.KeyScanCommand	withOptions(ScanOptions options)	Applies ScanOptions.

Methods inherited from class org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand

getKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.redis.connection.ReactiveRedisConnection.Command

getName

Method Details

key

public static ReactiveRedisConnection.KeyScanCommand key(ByteBuffer key)

Creates a new ReactiveRedisConnection.KeyScanCommand given a key.

Parameters:

key - must not be null.

Returns:

a new ReactiveRedisConnection.KeyScanCommand for key.

withOptions

public ReactiveRedisConnection.KeyScanCommand withOptions(ScanOptions options)

Applies ScanOptions. Constructs a new command instance with all previously configured properties.

Parameters:

options - must not be null.

Returns:

a new ReactiveRedisConnection.KeyScanCommand with ScanOptions applied.

getOptions

public ScanOptions getOptions()

Get the ScanOptions to apply.

Returns:

never null.