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

Class SamplerAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregationBase

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, AggregationVariant, ToCopyableBuilder<SamplerAggregation.Builder,SamplerAggregation>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class SamplerAggregation
extends BucketAggregationBase
implements AggregationVariant, ToCopyableBuilder<SamplerAggregation.Builder,SamplerAggregation>

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static SamplerAggregation.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static SamplerAggregation	of(Function<SamplerAggregation.Builder,ObjectBuilder<SamplerAggregation>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupSamplerAggregationDeserializer(ObjectDeserializer<SamplerAggregation.Builder> op)
final Integer	shardSize()	Limits how many top-scoring documents are collected in the sample processed on each shard.
SamplerAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

setupBucketAggregationBaseDeserializer

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase

meta, name, serialize, setupAggregationBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant

toAggregation

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SamplerAggregation> _DESERIALIZER

Json deserializer for SamplerAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

shardSize

@Nullable
public final Integer shardSize()

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

API name: shard_size

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

toBuilder

@Nonnull
public SamplerAggregation.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SamplerAggregation.Builder,SamplerAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static SamplerAggregation.Builder builder()

setupSamplerAggregationDeserializer

protected static void setupSamplerAggregationDeserializer(ObjectDeserializer<SamplerAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase