Class HighlightArgs
java.lang.Object
io.quarkus.redis.datasource.search.HighlightArgs
- All Implemented Interfaces:
RedisCommandExtraArguments
Allows customizing the highlighting.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionEach passed field is highlighted.Configure the tags wrapping the highlighted words.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 Details
-
HighlightArgs
public HighlightArgs()
-
-
Method Details
-
fields
Each passed field is highlighted. If noFIELDS
directive is passed, then all fields returned are highlighted.- Parameters:
fields
- the fields- Returns:
- the current
HighlightArgs
-
tags
Configure the tags wrapping the highlighted words.open
is prepended to each term match,close
is appended to it. If noTAGS
are specified, a built-in tag value is appended and prepended.- Parameters:
open
- the open tagclose
- the close tag- Returns:
- the current
HighlightArgs
-
toArgs
- Specified by:
toArgs
in interfaceRedisCommandExtraArguments
- Returns:
- the list of arguments.
-