zio-elasticsearch
API
Generated with
zio-elasticsearch/zio.elasticsearch/ElasticHighlight

ElasticHighlight

zio.elasticsearch.ElasticHighlight$
object ElasticHighlight

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Value members

Concrete methods

final def highlight(field: Field[_, _]): Highlights

Constructs a type-safe instance of Highlights using the type-safe field parameter.

Constructs a type-safe instance of Highlights using the type-safe field parameter.

Attributes

field

the Field object representing the type-safe field to highlight

Returns:

an instance of Highlights with a single HighlightField.

final def highlight(field: String): Highlights

Constructs an instance of Highlights using the field parameter.

Constructs an instance of Highlights using the field parameter.

Attributes

field

the field to highlight

Returns:

an instance of Highlights with a single HighlightField.

final def highlight(field: Field[_, _], config: Map[String, Json]): Highlights

Constructs a type-safe instance of Highlights using the specified parameters.

Constructs a type-safe instance of Highlights using the specified parameters.

Attributes

config

a map of highlight options

field

the Field object representing the type-safe field to highlight

Returns:

an instance of Highlights with a single HighlightField.

final def highlight(field: String, config: Map[String, Json]): Highlights

Constructs an instance of Highlights using the specified parameters.

Constructs an instance of Highlights using the specified parameters.

Attributes

config

a map of highlight options

field

the field to highlight

Returns:

an instance of Highlights with a single HighlightField.

Generated with