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

Class HistogramAggregation

java.lang.Object

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

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

org.opensearch.client.opensearch._types.aggregations.HistogramAggregation

All Implemented Interfaces:

JsonpSerializable, AggregationVariant

@JsonpDeserializable
public class HistogramAggregation
extends BucketAggregationBase
implements AggregationVariant

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
ExtendedBounds<java.lang.Double>	extendedBounds()	API name: extended_bounds
java.lang.String	field()	API name: field
java.lang.String	format()	API name: format
ExtendedBounds<java.lang.Double>	hardBounds()	API name: hard_bounds
java.lang.Double	interval()	API name: interval
java.lang.Boolean	keyed()	API name: keyed
java.lang.Integer	minDocCount()	API name: min_doc_count
java.lang.Double	missing()	API name: missing
static HistogramAggregation	of(java.util.function.Function<HistogramAggregation.Builder,ObjectBuilder<HistogramAggregation>> fn)
java.lang.Double	offset()	API name: offset
HistogramOrder	order()	API name: order
Script	script()	API name: script
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupHistogramAggregationDeserializer(ObjectDeserializer<HistogramAggregation.Builder> op)

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

_toAggregation

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<HistogramAggregation> _DESERIALIZER

Json deserializer for HistogramAggregation

Method Detail

of

public static HistogramAggregation of(java.util.function.Function<HistogramAggregation.Builder,ObjectBuilder<HistogramAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

extendedBounds

@Nullable
public final ExtendedBounds<java.lang.Double> extendedBounds()

API name: extended_bounds

hardBounds

@Nullable
public final ExtendedBounds<java.lang.Double> hardBounds()

API name: hard_bounds

field

@Nullable
public final java.lang.String field()

API name: field

interval

@Nullable
public final java.lang.Double interval()

API name: interval

minDocCount

@Nullable
public final java.lang.Integer minDocCount()

API name: min_doc_count

missing

@Nullable
public final java.lang.Double missing()

API name: missing

offset

@Nullable
public final java.lang.Double offset()

API name: offset

order

@Nullable
public final HistogramOrder order()

API name: order

script

@Nullable
public final Script script()

API name: script

format

@Nullable
public final java.lang.String format()

API name: format

keyed

@Nullable
public final java.lang.Boolean keyed()

API name: keyed

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

setupHistogramAggregationDeserializer

protected static void setupHistogramAggregationDeserializer(ObjectDeserializer<HistogramAggregation.Builder> op)