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

Class HistogramBucket

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.MultiBucketBase

org.opensearch.client.opensearch._types.aggregations.HistogramBucket

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<HistogramBucket.Builder,HistogramBucket>

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.MultiBucketBase

MultiBucketBase.AbstractBuilder<BuilderT extends MultiBucketBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static HistogramBucket.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final double	key()	Required - API name: key
final String	keyAsString()	API name: key_as_string
static HistogramBucket	of(Function<HistogramBucket.Builder,ObjectBuilder<HistogramBucket>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupHistogramBucketDeserializer(ObjectDeserializer<HistogramBucket.Builder> op)
HistogramBucket.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.MultiBucketBase

aggregations, docCount, serialize, setupMultiBucketBaseDeserializer

Methods inherited from class java.lang.Object

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

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

Json deserializer for HistogramBucket

Method Details

of

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

key

public final double key()

Required - API name: key

keyAsString

@Nullable
public final String keyAsString()

API name: key_as_string

serializeInternal

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

Overrides:

serializeInternal in class MultiBucketBase

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static HistogramBucket.Builder builder()

setupHistogramBucketDeserializer

protected static void setupHistogramBucketDeserializer(ObjectDeserializer<HistogramBucket.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class MultiBucketBase

equals

public boolean equals(Object o)

Overrides:

equals in class MultiBucketBase