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

Class PhraseSuggestHighlight.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.PhraseSuggestHighlight.Builder

All Implemented Interfaces:

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

Enclosing class:

PhraseSuggestHighlight

public static class PhraseSuggestHighlight.Builder
extends ObjectBuilderBase
implements CopyableBuilder<PhraseSuggestHighlight.Builder,PhraseSuggestHighlight>

Builder for PhraseSuggestHighlight.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PhraseSuggestHighlight	build()	Builds a PhraseSuggestHighlight.
PhraseSuggestHighlight.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PhraseSuggestHighlight.Builder	postTag(String value)	Required - API name: post_tag
final PhraseSuggestHighlight.Builder	preTag(String value)	Required - API name: pre_tag

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 PhraseSuggestHighlight.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<PhraseSuggestHighlight.Builder,PhraseSuggestHighlight>

Returns:

a new builder instance.

postTag

@Nonnull
public final PhraseSuggestHighlight.Builder postTag(String value)

Required - API name: post_tag

preTag

@Nonnull
public final PhraseSuggestHighlight.Builder preTag(String value)

Required - API name: pre_tag

build

@Nonnull
public PhraseSuggestHighlight build()

Builds a PhraseSuggestHighlight.

Specified by:

build in interface ObjectBuilder<PhraseSuggestHighlight>

Throws:

NullPointerException - if some of the required fields are null.