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

Class MultiBucketBase.AbstractBuilder<BuilderT extends MultiBucketBase.AbstractBuilder<BuilderT>>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.MultiBucketBase.AbstractBuilder<BuilderT>

Direct Known Subclasses:

AdjacencyMatrixBucket.Builder, CompositeBucket.Builder, DateHistogramBucket.Builder, FiltersBucket.Builder, GeoHashGridBucket.Builder, GeoTileGridBucket.Builder, HistogramBucket.Builder, IpRangeBucket.Builder, LongRareTermsBucket.Builder, MultiTermsBucket.Builder, RangeBucket.Builder, SignificantTermsBucketBase.AbstractBuilder, StringRareTermsBucket.Builder, TermsBucketBase.AbstractBuilder, VariableWidthHistogramBucket.Builder

Enclosing class:

MultiBucketBase

public abstract static class MultiBucketBase.AbstractBuilder<BuilderT extends MultiBucketBase.AbstractBuilder<BuilderT>>
extends ObjectBuilderBase

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Aggregate>	aggregations

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()
protected	AbstractBuilder(MultiBucketBase o)
protected	AbstractBuilder(MultiBucketBase.AbstractBuilder<BuilderT> o)

Method Summary

Modifier and Type	Method	Description
final BuilderT	aggregations(String key, Function<Aggregate.Builder,ObjectBuilder<Aggregate>> fn)	Nested aggregations.
final BuilderT	aggregations(String key, Aggregate value)	Nested aggregations.
final BuilderT	aggregations(Map<String,Aggregate> map)	Nested aggregations.
final BuilderT	docCount(long value)	Required - API name: doc_count
protected abstract BuilderT	self()

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

Field Details

aggregations

@Nullable
protected Map<String,Aggregate> aggregations

Constructor Details

AbstractBuilder

protected AbstractBuilder()

AbstractBuilder

protected AbstractBuilder(MultiBucketBase o)

AbstractBuilder

protected AbstractBuilder(MultiBucketBase.AbstractBuilder<BuilderT> o)

Method Details

self

@Nonnull
protected abstract BuilderT self()

aggregations

@Nonnull
public final BuilderT aggregations(Map<String,Aggregate> map)

Nested aggregations.

Adds all elements of map to aggregations.

aggregations

@Nonnull
public final BuilderT aggregations(String key,
 Aggregate value)

Nested aggregations.

Adds an entry to aggregations.

aggregations

@Nonnull
public final BuilderT aggregations(String key,
 Function<Aggregate.Builder,ObjectBuilder<Aggregate>> fn)

Nested aggregations.

Adds a value to aggregations using a builder lambda.

docCount

@Nonnull
public final BuilderT docCount(long value)

Required - API name: doc_count