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

Class HistogramAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.Aggregation

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

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

All Implemented Interfaces:

ToJsonp

public final class HistogramAggregation
extends BucketAggregationBase

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HistogramAggregation(HistogramAggregation.Builder builder)

Method Summary

Modifier and Type	Method	Description
ExtendedBounds<java.lang.Number>	extendedBounds()	API name: extended_bounds
java.lang.String	field()	API name: field
java.lang.String	format()	API name: format
ExtendedBounds<java.lang.Number>	hardBounds()	API name: hard_bounds
java.lang.Number	interval()	API name: interval
java.lang.Number	minDocCount()	API name: min_doc_count
java.lang.Number	missing()	API name: missing
java.lang.Number	offset()	API name: offset
HistogramOrder	order()	API name: order
jakarta.json.JsonValue	script()	API name: script
protected static void	setupHistogramAggregationDeserializer(DelegatingDeserializer<HistogramAggregation.Builder> op)
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

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

aggregations, setupBucketAggregationBaseDeserializer

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

meta, name, setupAggregationDeserializer, toJsonp

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<HistogramAggregation> DESERIALIZER

Json deserializer for HistogramAggregation

Constructor Details

HistogramAggregation

protected HistogramAggregation(HistogramAggregation.Builder builder)

Method Details

extendedBounds

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

API name: extended_bounds

hardBounds

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

API name: hard_bounds

field

@Nullable public java.lang.String field()

API name: field

interval

@Nullable public java.lang.Number interval()

API name: interval

minDocCount

@Nullable public java.lang.Number minDocCount()

API name: min_doc_count

missing

@Nullable public java.lang.Number missing()

API name: missing

offset

@Nullable public java.lang.Number offset()

API name: offset

order

@Nullable public HistogramOrder order()

API name: order

script

@Nullable public jakarta.json.JsonValue script()

API name: script

format

@Nullable public java.lang.String format()

API name: format

toJsonpInternal

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

Overrides:

toJsonpInternal in class BucketAggregationBase

setupHistogramAggregationDeserializer

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