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

Class VariableWidthHistogramAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.VariableWidthHistogramAggregation

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
final Integer	buckets()	The target number of buckets.
static VariableWidthHistogramAggregation.Builder	builder()
boolean	equals(Object o)
final String	field()	API name: field
int	hashCode()
final Integer	initialBuffer()	Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.
static VariableWidthHistogramAggregation	of(Function<VariableWidthHistogramAggregation.Builder,ObjectBuilder<VariableWidthHistogramAggregation>> fn)
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	setupVariableWidthHistogramAggregationDeserializer(ObjectDeserializer<VariableWidthHistogramAggregation.Builder> op)
final Integer	shardSize()	The number of buckets that the coordinating node will request from each shard.
VariableWidthHistogramAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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<VariableWidthHistogramAggregation> _DESERIALIZER

Json deserializer for VariableWidthHistogramAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

buckets

@Nullable
public final Integer buckets()

The target number of buckets.

API name: buckets

field

@Nullable
public final String field()

API name: field

initialBuffer

@Nullable
public final Integer initialBuffer()

Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. Defaults to min(10 * shard_size, 50000).

API name: initial_buffer

shardSize

@Nullable
public final Integer shardSize()

The number of buckets that the coordinating node will request from each shard. Defaults to buckets * 50.

API name: shard_size

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)

toBuilder

@Nonnull
public VariableWidthHistogramAggregation.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<VariableWidthHistogramAggregation.Builder,VariableWidthHistogramAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static VariableWidthHistogramAggregation.Builder builder()

setupVariableWidthHistogramAggregationDeserializer

protected static void setupVariableWidthHistogramAggregationDeserializer(ObjectDeserializer<VariableWidthHistogramAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object