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

Class AggregationProfile.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.AggregationProfile.Builder

All Implemented Interfaces:

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

Enclosing class:

AggregationProfile

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

Builder for AggregationProfile.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AggregationProfile.Builder	breakdown(Function<AggregationBreakdown.Builder,ObjectBuilder<AggregationBreakdown>> fn)	Required - API name: breakdown
final AggregationProfile.Builder	breakdown(AggregationBreakdown value)	Required - API name: breakdown
AggregationProfile	build()	Builds a AggregationProfile.
final AggregationProfile.Builder	children(Function<AggregationProfile.Builder,ObjectBuilder<AggregationProfile>> fn)	API name: children
final AggregationProfile.Builder	children(List<AggregationProfile> list)	API name: children
final AggregationProfile.Builder	children(AggregationProfile value, AggregationProfile... values)	API name: children
AggregationProfile.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AggregationProfile.Builder	debug(Function<AggregationProfileDebug.Builder,ObjectBuilder<AggregationProfileDebug>> fn)	API name: debug
final AggregationProfile.Builder	debug(AggregationProfileDebug value)	API name: debug
final AggregationProfile.Builder	description(String value)	Required - API name: description
final AggregationProfile.Builder	timeInNanos(long value)	Required - API name: time_in_nanos
final AggregationProfile.Builder	type(String value)	Required - API name: 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 AggregationProfile.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<AggregationProfile.Builder,AggregationProfile>

Returns:

a new builder instance.

breakdown

@Nonnull
public final AggregationProfile.Builder breakdown(AggregationBreakdown value)

Required - API name: breakdown

breakdown

@Nonnull
public final AggregationProfile.Builder breakdown(Function<AggregationBreakdown.Builder,ObjectBuilder<AggregationBreakdown>> fn)

Required - API name: breakdown

children

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

API name: children

Adds all elements of list to children.

children

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

API name: children

Adds one or more values to children.

children

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

API name: children

Adds a value to children using a builder lambda.

debug

@Nonnull
public final AggregationProfile.Builder debug(@Nullable
 AggregationProfileDebug value)

API name: debug

debug

@Nonnull
public final AggregationProfile.Builder debug(Function<AggregationProfileDebug.Builder,ObjectBuilder<AggregationProfileDebug>> fn)

API name: debug

description

@Nonnull
public final AggregationProfile.Builder description(String value)

Required - API name: description

timeInNanos

@Nonnull
public final AggregationProfile.Builder timeInNanos(long value)

Required - API name: time_in_nanos

type

@Nonnull
public final AggregationProfile.Builder type(String value)

Required - API name: type

build

@Nonnull
public AggregationProfile build()

Builds a AggregationProfile.

Specified by:

build in interface ObjectBuilder<AggregationProfile>

Throws:

NullPointerException - if some of the required fields are null.