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, PlainJsonSerializable, AggregationVariant, ToCopyableBuilder<HistogramAggregation.Builder,HistogramAggregation>

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

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static HistogramAggregation.Builder	builder()
boolean	equals(Object o)
final ExtendedBounds<Double>	extendedBounds()	API name: extended_bounds
final String	field()	API name: field
final String	format()	API name: format
final ExtendedBounds<Double>	hardBounds()	API name: hard_bounds
int	hashCode()
final Double	interval()	The interval for the buckets.
final Boolean	keyed()	If true, returns buckets as a hash instead of an array, keyed by the bucket keys.
final Integer	minDocCount()	Only returns buckets that have min_doc_count number of documents.
final Double	missing()	The value to apply to documents that do not have a value.
static HistogramAggregation	of(Function<HistogramAggregation.Builder,ObjectBuilder<HistogramAggregation>> fn)
final Double	offset()	By default, the bucket keys start with 0 and then continue in even spaced steps of interval.
final HistogramOrder	order()	API name: order
final Script	script()	API name: script
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupHistogramAggregationDeserializer(ObjectDeserializer<HistogramAggregation.Builder> op)
HistogramAggregation.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<HistogramAggregation> _DESERIALIZER

Json deserializer for HistogramAggregation

Method Details

of

public static HistogramAggregation of(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<Double> extendedBounds()

API name: extended_bounds

field

@Nullable
public final String field()

API name: field

format

@Nullable
public final String format()

API name: format

hardBounds

@Nullable
public final ExtendedBounds<Double> hardBounds()

API name: hard_bounds

interval

@Nullable
public final Double interval()

The interval for the buckets. Must be a positive decimal.

API name: interval

keyed

@Nullable
public final Boolean keyed()

If true, returns buckets as a hash instead of an array, keyed by the bucket keys.

API name: keyed

minDocCount

@Nullable
public final Integer minDocCount()

Only returns buckets that have min_doc_count number of documents. By default, the response will fill gaps in the histogram with empty buckets.

API name: min_doc_count

missing

@Nullable
public final Double missing()

The value to apply to documents that do not have a value. By default, documents without a value are ignored.

API name: missing

offset

@Nullable
public final Double offset()

By default, the bucket keys start with 0 and then continue in even spaced steps of interval. The bucket boundaries can be shifted by using the offset option.

API name: offset

order

@Nullable
public final HistogramOrder order()

API name: order

script

@Nullable
public final Script script()

API name: script

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static HistogramAggregation.Builder builder()

setupHistogramAggregationDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase