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

Class DiversifiedSamplerAggregation

java.lang.Object

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

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

org.opensearch.client.opensearch._types.aggregations.DiversifiedSamplerAggregation

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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<DiversifiedSamplerAggregation>	_DESERIALIZER	Json deserializer for DiversifiedSamplerAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static DiversifiedSamplerAggregation.Builder	builder()
boolean	equals(Object o)
final SamplerAggregationExecutionHint	executionHint()	API name: execution_hint
final String	field()	API name: field
int	hashCode()
final Integer	maxDocsPerValue()	Limits how many documents are permitted per choice of de-duplicating value.
static DiversifiedSamplerAggregation	of(Function<DiversifiedSamplerAggregation.Builder,ObjectBuilder<DiversifiedSamplerAggregation>> fn)
final Script	script()	API name: script
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupDiversifiedSamplerAggregationDeserializer(ObjectDeserializer<DiversifiedSamplerAggregation.Builder> op)
final Integer	shardSize()	Limits how many top-scoring documents are collected in the sample processed on each shard.
DiversifiedSamplerAggregation.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<DiversifiedSamplerAggregation> _DESERIALIZER

Json deserializer for DiversifiedSamplerAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

executionHint

@Nullable
public final SamplerAggregationExecutionHint executionHint()

API name: execution_hint

field

@Nullable
public final String field()

API name: field

maxDocsPerValue

@Nullable
public final Integer maxDocsPerValue()

Limits how many documents are permitted per choice of de-duplicating value.

API name: max_docs_per_value

script

@Nullable
public final Script script()

API name: script

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

Returns:

a new builder instance.

builder

@Nonnull
public static DiversifiedSamplerAggregation.Builder builder()

setupDiversifiedSamplerAggregationDeserializer

protected static void setupDiversifiedSamplerAggregationDeserializer(ObjectDeserializer<DiversifiedSamplerAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase