Package org.opensearch.client.opensearch.core.search

Class HighlightField.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.HighlightBase.AbstractBuilder<HighlightField.Builder>

org.opensearch.client.opensearch.core.search.HighlightField.Builder

All Implemented Interfaces:

CopyableBuilder<HighlightField.Builder,HighlightField>, MutableBuilder<HighlightField.Builder,HighlightField>, ObjectBuilder<HighlightField>

Enclosing class:

HighlightField

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

Builder for HighlightField.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final HighlightField.Builder	analyzer(Function<Analyzer.Builder,ObjectBuilder<Analyzer>> fn)	API name: analyzer
final HighlightField.Builder	analyzer(Analyzer value)	API name: analyzer
HighlightField	build()	Builds a HighlightField.
HighlightField.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
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 org.opensearch.client.opensearch.core.search.HighlightBase.AbstractBuilder

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

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public HighlightField.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<HighlightField.Builder,HighlightField>

Returns:

a new builder instance.

self

@Nonnull
protected HighlightField.Builder self()

Specified by:

self in class HighlightBase.AbstractBuilder<HighlightField.Builder>

analyzer

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

API name: analyzer

analyzer

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

API name: analyzer

matchedFields

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

API name: matched_fields

Adds all elements of list to matchedFields.

matchedFields

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

API name: matched_fields

Adds one or more values to matchedFields.

build

@Nonnull
public HighlightField build()

Builds a HighlightField.

Specified by:

build in interface ObjectBuilder<HighlightField>

Throws:

NullPointerException - if some of the required fields are null.