Package org.opensearch.client.opensearch._types.aggregations

Class NestedAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<NestedAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<NestedAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.NestedAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

NestedAggregation

public static class NestedAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<NestedAggregation.Builder>
implements CopyableBuilder<NestedAggregation.Builder,NestedAggregation>

Builder for NestedAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NestedAggregation	build()	Builds a NestedAggregation.
NestedAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final NestedAggregation.Builder	path(String value)	API name: path
protected NestedAggregation.Builder	self()

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder

meta, meta, name

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

Returns:

a new builder instance.

self

@Nonnull
protected NestedAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<NestedAggregation.Builder>

path

@Nonnull
public final NestedAggregation.Builder path(@Nullable
 String value)

API name: path

build

@Nonnull
public NestedAggregation build()

Builds a NestedAggregation.

Specified by:

build in interface ObjectBuilder<NestedAggregation>

Throws:

NullPointerException - if some of the required fields are null.