HighlightArgs (Quarkus - Redis Client - Runtime 2.16.0.Final API)

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

All Implemented Interfaces:

RedisCommandExtraArguments
```
public class HighlightArgs
extends Object
implements RedisCommandExtraArguments
```
Allows customizing the highlighting.

Constructor Summary

Constructors
Constructor Description

HighlightArgs()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`HighlightArgs`	`fields(String... fields)`	Each passed field is highlighted.
`HighlightArgs`	`tags(String open, String close)`	Configure the tags wrapping the highlighted words.
`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
  - HighlightArgs
```
public HighlightArgs()
```
- Method Detail
  - fields
```
public HighlightArgs fields(String... fields)
```
    Each passed field is highlighted. If no FIELDS directive is passed, then all fields returned are highlighted.
    
    Parameters:
    
    fields - the fields
    
    Returns:
    
    the current HighlightArgs
  - tags
```
public HighlightArgs tags(String open,
                          String close)
```
    Configure the tags wrapping the highlighted words. open is prepended to each term match, close is appended to it. If no TAGS are specified, a built-in tag value is appended and prepended.
    
    Parameters:
    
    open - the open tag
    
    close - the close tag
    
    Returns:
    
    the current HighlightArgs
  - toArgs
```
public List<String> toArgs()
```
    Specified by:
    
    toArgs in interface RedisCommandExtraArguments
    
    Returns:
    
    the list of arguments, encoded as a list of String.