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

Class PhraseSuggestCollate.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.PhraseSuggestCollate.Builder

All Implemented Interfaces:

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

Enclosing class:

PhraseSuggestCollate

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

Builder for PhraseSuggestCollate.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PhraseSuggestCollate	build()	Builds a PhraseSuggestCollate.
PhraseSuggestCollate.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PhraseSuggestCollate.Builder	params(String key, JsonData value)	API name: params
final PhraseSuggestCollate.Builder	params(Map<String,JsonData> map)	API name: params
final PhraseSuggestCollate.Builder	prune(Boolean value)	API name: prune
final PhraseSuggestCollate.Builder	query(Function<PhraseSuggestCollateQuery.Builder,ObjectBuilder<PhraseSuggestCollateQuery>> fn)	Required - API name: query
final PhraseSuggestCollate.Builder	query(PhraseSuggestCollateQuery value)	Required - API name: query

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

Returns:

a new builder instance.

params

@Nonnull
public final PhraseSuggestCollate.Builder params(Map<String,JsonData> map)

API name: params

Adds all elements of map to params.

params

@Nonnull
public final PhraseSuggestCollate.Builder params(String key,
 JsonData value)

API name: params

Adds an entry to params.

prune

@Nonnull
public final PhraseSuggestCollate.Builder prune(@Nullable
 Boolean value)

API name: prune

query

@Nonnull
public final PhraseSuggestCollate.Builder query(PhraseSuggestCollateQuery value)

Required - API name: query

query

@Nonnull
public final PhraseSuggestCollate.Builder query(Function<PhraseSuggestCollateQuery.Builder,ObjectBuilder<PhraseSuggestCollateQuery>> fn)

Required - API name: query

build

@Nonnull
public PhraseSuggestCollate build()

Builds a PhraseSuggestCollate.

Specified by:

build in interface ObjectBuilder<PhraseSuggestCollate>

Throws:

NullPointerException - if some of the required fields are null.