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

Class SamplerAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

org.opensearch.client.opensearch._types.aggregations.SamplerAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

SamplerAggregation

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

Builder for SamplerAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SamplerAggregation	build()	Builds a SamplerAggregation.
SamplerAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected SamplerAggregation.Builder	self()
final SamplerAggregation.Builder	shardSize(Integer value)	Limits how many top-scoring documents are collected in the sample processed on each shard.

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

Returns:

a new builder instance.

self

@Nonnull
protected SamplerAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<SamplerAggregation.Builder>

shardSize

@Nonnull
public final SamplerAggregation.Builder shardSize(@Nullable
 Integer value)

Limits how many top-scoring documents are collected in the sample processed on each shard.

API name: shard_size

build

@Nonnull
public SamplerAggregation build()

Builds a SamplerAggregation.

Specified by:

build in interface ObjectBuilder<SamplerAggregation>

Throws:

NullPointerException - if some of the required fields are null.