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

Class Highlight.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.core.search.Highlight.Builder

All Implemented Interfaces:

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

Enclosing class:

Highlight

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

Builder for Highlight.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Highlight	build()	Builds a Highlight.
Highlight.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Highlight.Builder	encoder(HighlighterEncoder value)	API name: encoder
final Highlight.Builder	fields(String key, Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)	Required - API name: fields
final Highlight.Builder	fields(String key, HighlightField value)	Required - API name: fields
final Highlight.Builder	fields(Map<String,HighlightField> map)	Required - API name: fields
protected Highlight.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 Highlight.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<Highlight.Builder,Highlight>

Returns:

a new builder instance.

self

@Nonnull
protected Highlight.Builder self()

Specified by:

self in class HighlightBase.AbstractBuilder<Highlight.Builder>

encoder

@Nonnull
public final Highlight.Builder encoder(@Nullable
 HighlighterEncoder value)

API name: encoder

fields

@Nonnull
public final Highlight.Builder fields(Map<String,HighlightField> map)

Required - API name: fields

Adds all elements of map to fields.

fields

@Nonnull
public final Highlight.Builder fields(String key,
 HighlightField value)

Required - API name: fields

Adds an entry to fields.

fields

@Nonnull
public final Highlight.Builder fields(String key,
 Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)

Required - API name: fields

Adds a value to fields using a builder lambda.

build

@Nonnull
public Highlight build()

Builds a Highlight.

Specified by:

build in interface ObjectBuilder<Highlight>

Throws:

NullPointerException - if some of the required fields are null.