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

Class ShardProfile.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.ShardProfile.Builder

All Implemented Interfaces:

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

Enclosing class:

ShardProfile

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

Builder for ShardProfile.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ShardProfile.Builder	aggregations(Function<AggregationProfile.Builder,ObjectBuilder<AggregationProfile>> fn)	Required - API name: aggregations
final ShardProfile.Builder	aggregations(List<AggregationProfile> list)	Required - API name: aggregations
final ShardProfile.Builder	aggregations(AggregationProfile value, AggregationProfile... values)	Required - API name: aggregations
ShardProfile	build()	Builds a ShardProfile.
ShardProfile.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardProfile.Builder	fetch(Function<FetchProfile.Builder,ObjectBuilder<FetchProfile>> fn)	API name: fetch
final ShardProfile.Builder	fetch(FetchProfile value)	API name: fetch
final ShardProfile.Builder	id(String value)	Required - API name: id
final ShardProfile.Builder	searches(Function<SearchProfile.Builder,ObjectBuilder<SearchProfile>> fn)	Required - API name: searches
final ShardProfile.Builder	searches(List<SearchProfile> list)	Required - API name: searches
final ShardProfile.Builder	searches(SearchProfile value, SearchProfile... values)	Required - API name: searches

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

Returns:

a new builder instance.

aggregations

@Nonnull
public final ShardProfile.Builder aggregations(List<AggregationProfile> list)

Required - API name: aggregations

Adds all elements of list to aggregations.

aggregations

@Nonnull
public final ShardProfile.Builder aggregations(AggregationProfile value,
 AggregationProfile... values)

Required - API name: aggregations

Adds one or more values to aggregations.

aggregations

@Nonnull
public final ShardProfile.Builder aggregations(Function<AggregationProfile.Builder,ObjectBuilder<AggregationProfile>> fn)

Required - API name: aggregations

Adds a value to aggregations using a builder lambda.

fetch

@Nonnull
public final ShardProfile.Builder fetch(@Nullable
 FetchProfile value)

API name: fetch

fetch

@Nonnull
public final ShardProfile.Builder fetch(Function<FetchProfile.Builder,ObjectBuilder<FetchProfile>> fn)

API name: fetch

id

@Nonnull
public final ShardProfile.Builder id(String value)

Required - API name: id

searches

@Nonnull
public final ShardProfile.Builder searches(List<SearchProfile> list)

Required - API name: searches

Adds all elements of list to searches.

searches

@Nonnull
public final ShardProfile.Builder searches(SearchProfile value,
 SearchProfile... values)

Required - API name: searches

Adds one or more values to searches.

searches

@Nonnull
public final ShardProfile.Builder searches(Function<SearchProfile.Builder,ObjectBuilder<SearchProfile>> fn)

Required - API name: searches

Adds a value to searches using a builder lambda.

build

@Nonnull
public ShardProfile build()

Builds a ShardProfile.

Specified by:

build in interface ObjectBuilder<ShardProfile>

Throws:

NullPointerException - if some of the required fields are null.