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

Class SingleBucketAggregateBase.AbstractBuilder<BuilderT extends SingleBucketAggregateBase.AbstractBuilder<BuilderT>>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

Direct Known Subclasses:

ChildrenAggregate.Builder, FilterAggregate.Builder, GlobalAggregate.Builder, MissingAggregate.Builder, NestedAggregate.Builder, ParentAggregate.Builder, ReverseNestedAggregate.Builder, SamplerAggregate.Builder

Enclosing class:

SingleBucketAggregateBase

public abstract static class SingleBucketAggregateBase.AbstractBuilder<BuilderT extends SingleBucketAggregateBase.AbstractBuilder<BuilderT>>
extends AggregateBase.AbstractBuilder<BuilderT>

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final BuilderT	aggregations(String key, Function<Aggregate.Builder,ObjectBuilder<Aggregate>> fn)	Adds a value to aggregations using a builder lambda.
final BuilderT	aggregations(String key, Aggregate value)	Adds an entry to aggregations.
final BuilderT	aggregations(Map<String,Aggregate> map)	Adds all elements of map to aggregations.
final BuilderT	docCount(long value)	Required - API name: doc_count

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

meta, meta, 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(SingleBucketAggregateBase o)

AbstractBuilder

protected AbstractBuilder(SingleBucketAggregateBase.AbstractBuilder<BuilderT> o)

Method Details

aggregations

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

Adds all elements of map to aggregations.

aggregations

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

Adds an entry to aggregations.

aggregations

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

Adds a value to aggregations using a builder lambda.

docCount

@Nonnull
public final BuilderT docCount(long value)

Required - API name: doc_count