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

Class SearchProfile.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.SearchProfile.Builder

All Implemented Interfaces:

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

Enclosing class:

SearchProfile

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

Builder for SearchProfile.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SearchProfile	build()	Builds a SearchProfile.
final SearchProfile.Builder	collector(Function<Collector.Builder,ObjectBuilder<Collector>> fn)	Required - API name: collector
final SearchProfile.Builder	collector(List<Collector> list)	Required - API name: collector
final SearchProfile.Builder	collector(Collector value, Collector... values)	Required - API name: collector
SearchProfile.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SearchProfile.Builder	query(Function<QueryProfile.Builder,ObjectBuilder<QueryProfile>> fn)	Required - API name: query
final SearchProfile.Builder	query(List<QueryProfile> list)	Required - API name: query
final SearchProfile.Builder	query(QueryProfile value, QueryProfile... values)	Required - API name: query
final SearchProfile.Builder	rewriteTime(long value)	Required - API name: rewrite_time

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

Returns:

a new builder instance.

collector

@Nonnull
public final SearchProfile.Builder collector(List<Collector> list)

Required - API name: collector

Adds all elements of list to collector.

collector

@Nonnull
public final SearchProfile.Builder collector(Collector value,
 Collector... values)

Required - API name: collector

Adds one or more values to collector.

collector

@Nonnull
public final SearchProfile.Builder collector(Function<Collector.Builder,ObjectBuilder<Collector>> fn)

Required - API name: collector

Adds a value to collector using a builder lambda.

query

@Nonnull
public final SearchProfile.Builder query(List<QueryProfile> list)

Required - API name: query

Adds all elements of list to query.

query

@Nonnull
public final SearchProfile.Builder query(QueryProfile value,
 QueryProfile... values)

Required - API name: query

Adds one or more values to query.

query

@Nonnull
public final SearchProfile.Builder query(Function<QueryProfile.Builder,ObjectBuilder<QueryProfile>> fn)

Required - API name: query

Adds a value to query using a builder lambda.

rewriteTime

@Nonnull
public final SearchProfile.Builder rewriteTime(long value)

Required - API name: rewrite_time

build

@Nonnull
public SearchProfile build()

Builds a SearchProfile.

Specified by:

build in interface ObjectBuilder<SearchProfile>

Throws:

NullPointerException - if some of the required fields are null.