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

Class RandomSamplerAggregation

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

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

All Implemented Interfaces:

AggregationVariant, JsonpSerializable

@JsonpDeserializable
public class RandomSamplerAggregation
extends BucketAggregationBase
implements AggregationVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RandomSamplerAggregation.Builder	Builder for RandomSamplerAggregation.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<RandomSamplerAggregation>	_DESERIALIZER	Json deserializer for RandomSamplerAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static RandomSamplerAggregation	of(Function<RandomSamplerAggregation.Builder,ObjectBuilder<RandomSamplerAggregation>> fn)
final double	probability()	Required - The probability that a document will be included in the aggregated data.
final Integer	seed()	The seed to generate the random sampling of documents.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRandomSamplerAggregationDeserializer(ObjectDeserializer<RandomSamplerAggregation.Builder> op)
final Integer	shardSeed()	When combined with seed, setting shard_seed ensures 100% consistent sampling over shards where data is exactly the same.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant

_toAggregation

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RandomSamplerAggregation> _DESERIALIZER

Json deserializer for RandomSamplerAggregation

Method Details

of

public static RandomSamplerAggregation of(Function<RandomSamplerAggregation.Builder,ObjectBuilder<RandomSamplerAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

probability

public final double probability()

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

@Nullable
public final Integer seed()

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

@Nullable
public final Integer shardSeed()

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

API name: shard_seed

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupRandomSamplerAggregationDeserializer

protected static void setupRandomSamplerAggregationDeserializer(ObjectDeserializer<RandomSamplerAggregation.Builder> op)