Package co.elastic.clients.elasticsearch._types.aggregations

Class RandomSamplerAggregation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase.AbstractBuilder<RandomSamplerAggregation.Builder>

co.elastic.clients.elasticsearch._types.aggregations.RandomSamplerAggregation.Builder

All Implemented Interfaces:

WithJson<RandomSamplerAggregation.Builder>, ObjectBuilder<RandomSamplerAggregation>

Enclosing class:

RandomSamplerAggregation

public static class RandomSamplerAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<RandomSamplerAggregation.Builder>
implements ObjectBuilder<RandomSamplerAggregation>

Builder for RandomSamplerAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RandomSamplerAggregation	build()	Builds a RandomSamplerAggregation.
final RandomSamplerAggregation.Builder	probability(double value)	Required - The probability that a document will be included in the aggregated data.
final RandomSamplerAggregation.Builder	seed(Integer value)	The seed to generate the random sampling of documents.
protected RandomSamplerAggregation.Builder	self()
final RandomSamplerAggregation.Builder	shardSeed(Integer value)	When combined with seed, setting shard_seed ensures 100% consistent sampling over shards where data is exactly the same.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

probability

public final RandomSamplerAggregation.Builder probability(double value)

Required - The probability that a document will be included in the aggregated data. Must be greater than 0, less than 0.5, or exactly 1. The lower the probability, the fewer documents are matched.

API name: probability

seed

public final RandomSamplerAggregation.Builder seed(@Nullable
 Integer value)

The seed to generate the random sampling of documents. When a seed is provided, the random subset of documents is the same between calls.

API name: seed

shardSeed

public final RandomSamplerAggregation.Builder shardSeed(@Nullable
 Integer value)

When combined with seed, setting shard_seed ensures 100% consistent sampling over shards where data is exactly the same.

API name: shard_seed

self

protected RandomSamplerAggregation.Builder self()

Specified by:

self in class BucketAggregationBase.AbstractBuilder<RandomSamplerAggregation.Builder>

build

public RandomSamplerAggregation build()

Builds a RandomSamplerAggregation.

Specified by:

build in interface ObjectBuilder<RandomSamplerAggregation>

Throws:

NullPointerException - if some of the required fields are null.