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

Class ChildrenAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

org.opensearch.client.opensearch._types.aggregations.ChildrenAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

ChildrenAggregation

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

Builder for ChildrenAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

Returns:

a new builder instance.

self

@Nonnull
protected ChildrenAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<ChildrenAggregation.Builder>

type

@Nonnull
public final ChildrenAggregation.Builder type(@Nullable
 String value)

API name: type

build

@Nonnull
public ChildrenAggregation build()

Builds a ChildrenAggregation.

Specified by:

build in interface ObjectBuilder<ChildrenAggregation>

Throws:

NullPointerException - if some of the required fields are null.