Package co.elastic.clients.elasticsearch.core.search

Class HighlightField.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch.core.search.HighlightBase.AbstractBuilder<HighlightField.Builder>

co.elastic.clients.elasticsearch.core.search.HighlightField.Builder

All Implemented Interfaces:

WithJson<HighlightField.Builder>, ObjectBuilder<HighlightField>

Enclosing class:

HighlightField

public static class HighlightField.Builder
extends HighlightBase.AbstractBuilder<HighlightField.Builder>
implements ObjectBuilder<HighlightField>

Builder for HighlightField.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final HighlightField.Builder	analyzer(Analyzer value)	API name: analyzer
final HighlightField.Builder	analyzer(Function<Analyzer.Builder,ObjectBuilder<Analyzer>> fn)	API name: analyzer
HighlightField	build()	Builds a HighlightField.
final HighlightField.Builder	fragmentOffset(Integer value)	API name: fragment_offset
final HighlightField.Builder	matchedFields(String value, String... values)	API name: matched_fields
final HighlightField.Builder	matchedFields(List<String> list)	API name: matched_fields
protected HighlightField.Builder	self()

Methods inherited from class co.elastic.clients.elasticsearch.core.search.HighlightBase.AbstractBuilder

boundaryChars, boundaryMaxScan, boundaryScanner, boundaryScannerLocale, forceSource, fragmenter, fragmentSize, highlightFilter, highlightQuery, highlightQuery, maxAnalyzedOffset, maxFragmentLength, noMatchSize, numberOfFragments, options, options, order, phraseLimit, postTags, postTags, preTags, preTags, requireFieldMatch, tagsSchema, type, type

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

fragmentOffset

public final HighlightField.Builder fragmentOffset(@Nullable
 Integer value)

API name: fragment_offset

matchedFields

public final HighlightField.Builder matchedFields(List<String> list)

API name: matched_fields

Adds all elements of list to matchedFields.

matchedFields

public final HighlightField.Builder matchedFields(String value,
 String... values)

API name: matched_fields

Adds one or more values to matchedFields.

analyzer

public final HighlightField.Builder analyzer(@Nullable
 Analyzer value)

API name: analyzer

analyzer

public final HighlightField.Builder analyzer(Function<Analyzer.Builder,ObjectBuilder<Analyzer>> fn)

API name: analyzer

self

protected HighlightField.Builder self()

Specified by:

self in class HighlightBase.AbstractBuilder<HighlightField.Builder>

build

public HighlightField build()

Builds a HighlightField.

Specified by:

build in interface ObjectBuilder<HighlightField>

Throws:

NullPointerException - if some of the required fields are null.