org.springframework.data.redis.core

Class KeyScanOptions

java.lang.Object

org.springframework.data.redis.core.ScanOptions

org.springframework.data.redis.core.KeyScanOptions

public class KeyScanOptions
extends ScanOptions

Options to be used for with SCAN commands.

Since:

2.6

Author:

Mark Paluch, Christoph Strobl

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.redis.core.ScanOptions

ScanOptions.ScanOptionsBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static KeyScanOptions	NONE Constant to apply default KeyScanOptions without setting a limit or matching a pattern.

Method Summary

Modifier and Type	Method and Description
String	getType()
static ScanOptions.ScanOptionsBuilder	scanOptions(DataType type) Static factory method that returns a new ScanOptionsBuilder.
String	toOptionString()

Methods inherited from class org.springframework.data.redis.core.ScanOptions

getBytePattern, getCount, getPattern, scanOptions

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static KeyScanOptions NONE

Constant to apply default KeyScanOptions without setting a limit or matching a pattern.

Method Detail

scanOptions

public static ScanOptions.ScanOptionsBuilder scanOptions(DataType type)

Static factory method that returns a new ScanOptionsBuilder.

Parameters:

type -

Returns:

getType

@Nullable
public String getType()

toOptionString

public String toOptionString()

Overrides:

toOptionString in class ScanOptions