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

Class StringTermsAggregate.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregateBase.AbstractBuilder<StringTermsAggregate.Builder>

org.opensearch.client.opensearch._types.aggregations.MultiBucketAggregateBase.AbstractBuilder<StringTermsBucket,StringTermsAggregate.Builder>

org.opensearch.client.opensearch._types.aggregations.TermsAggregateBase.AbstractBuilder<StringTermsBucket,StringTermsAggregate.Builder>

org.opensearch.client.opensearch._types.aggregations.StringTermsAggregate.Builder

All Implemented Interfaces:

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

Enclosing class:

StringTermsAggregate

public static class StringTermsAggregate.Builder
extends TermsAggregateBase.AbstractBuilder<StringTermsBucket,StringTermsAggregate.Builder>
implements CopyableBuilder<StringTermsAggregate.Builder,StringTermsAggregate>

Builder for StringTermsAggregate.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StringTermsAggregate	build()	Builds a StringTermsAggregate.
StringTermsAggregate.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected StringTermsAggregate.Builder	self()

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

docCountErrorUpperBound, sumOtherDocCount

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

buckets, buckets

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

meta, meta

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

Returns:

a new builder instance.

self

@Nonnull
protected StringTermsAggregate.Builder self()

Specified by:

self in class AggregateBase.AbstractBuilder<StringTermsAggregate.Builder>

build

@Nonnull
public StringTermsAggregate build()

Builds a StringTermsAggregate.

Specified by:

build in interface ObjectBuilder<StringTermsAggregate>

Throws:

NullPointerException - if some of the required fields are null.