SpellCheckArgs (Quarkus - Redis Client - Runtime 3.3.0 API)

java.lang.Object
- io.quarkus.redis.datasource.search.SpellCheckArgs

All Implemented Interfaces:: RedisCommandExtraArguments

public class SpellCheckArgs
extends Object
implements RedisCommandExtraArguments

Constructor Summary

Constructors
Constructor Description

SpellCheckArgs()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SpellCheckArgs`	`dialect(int dialect)`	Selects the dialect version under which to execute the query.
`SpellCheckArgs`	`distance(int distance)`	Sets the maximum Levenshtein distance for spelling suggestions (default: 1, max: 4).
`SpellCheckArgs`	`excludes(String... dict)`	Specifies an exclusion of a custom dictionary named `dict`
`SpellCheckArgs`	`includes(String... dict)`	Specifies an inclusion of a custom dictionary named `dict`
`List<String>`	`toArgs()`

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

Methods inherited from interface io.quarkus.redis.datasource.RedisCommandExtraArguments
toArgs

- Constructor Detail
  - SpellCheckArgs
```
public SpellCheckArgs()
```
- Method Detail
  - distance
```
public SpellCheckArgs distance(int distance)
```
    Sets the maximum Levenshtein distance for spelling suggestions (default: 1, max: 4).
    
    Parameters:
    
    distance - the distance
    
    Returns:
    
    the current SpellCheckArgs
  - includes
```
public SpellCheckArgs includes(String... dict)
```
    Specifies an inclusion of a custom dictionary named dict
    
    Parameters:
    
    dict - the dictionaries
    
    Returns:
    
    the current SpellCheckArgs
  - excludes
```
public SpellCheckArgs excludes(String... dict)
```
    Specifies an exclusion of a custom dictionary named dict
    
    Parameters:
    
    dict - the dictionaries
    
    Returns:
    
    the current SpellCheckArgs
  - dialect
```
public SpellCheckArgs dialect(int dialect)
```
    Selects the dialect version under which to execute the query. If not specified, the query will execute under the default dialect version set during module initial loading.
    
    Parameters:
    
    dialect - the dialect
    
    Returns:
    
    the current SpellCheckArgs
  - toArgs
```
public List<String> toArgs()
```
    Specified by:
    
    toArgs in interface RedisCommandExtraArguments
    
    Returns:
    
    the list of arguments, encoded as a list of String.