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

Class GlobalAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

org.opensearch.client.opensearch._types.aggregations.GlobalAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

GlobalAggregation

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

Builder for GlobalAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GlobalAggregation	build()	Builds a GlobalAggregation.
GlobalAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected GlobalAggregation.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 GlobalAggregation.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<GlobalAggregation.Builder,GlobalAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected GlobalAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<GlobalAggregation.Builder>

build

@Nonnull
public GlobalAggregation build()

Builds a GlobalAggregation.

Specified by:

build in interface ObjectBuilder<GlobalAggregation>

Throws:

NullPointerException - if some of the required fields are null.