KeyScanArgs (Quarkus - Redis Client - Runtime 3.5.0 API)

java.lang.Object
- io.quarkus.redis.datasource.ScanArgs
- - io.quarkus.redis.datasource.keys.KeyScanArgs

public class KeyScanArgs
extends ScanArgs

Represents the scan commands flags.

Constructor Summary

Constructors
Constructor Description

KeyScanArgs()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`KeyScanArgs`	`count(long count)`	Sets the max number of items in each batch.
`KeyScanArgs`	`match(String pattern)`	Sets a `MATCH` pattern
`List<String>`	`toArgs()`
`KeyScanArgs`	`type(RedisValueType type)`	You can use the TYPE option to ask SCAN to only return objects that match a given type, allowing you to iterate through the database looking for keys of a specific type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - KeyScanArgs
```
public KeyScanArgs()
```
- Method Detail
  - type
```
public KeyScanArgs type(RedisValueType type)
```
    You can use the TYPE option to ask SCAN to only return objects that match a given type, allowing you to iterate through the database looking for keys of a specific type.
    
    Parameters:
    
    type - the type value
    
    Returns:
    
    the current KeyScanArgs
  - count
```
public KeyScanArgs count(long count)
```
    Sets the max number of items in each batch. The default value is 10.
    
    Overrides:
    
    count in class ScanArgs
    
    Parameters:
    
    count - the number of item, must be strictly positive
    
    Returns:
    
    the current ScanArgs
  - match
```
public KeyScanArgs match(String pattern)
```
    Sets a MATCH pattern
    
    Overrides:
    
    match in class ScanArgs
    
    Parameters:
    
    pattern - the pattern, must not be null
    
    Returns:
    
    the current ScanArgs
  - toArgs
```
public List<String> toArgs()
```
    Overrides:
    
    toArgs in class ScanArgs