Package co.elastic.clients.elasticsearch.rollup

Class HistogramGrouping

java.lang.Object

co.elastic.clients.elasticsearch.rollup.HistogramGrouping

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class HistogramGrouping
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final List<String>	fields()	Required - The set of fields that you wish to build histograms for.
final long	interval()	Required - The interval of histogram buckets to be generated when rolling up.
static HistogramGrouping	of(Function<HistogramGrouping.Builder,ObjectBuilder<HistogramGrouping>> 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	setupHistogramGroupingDeserializer(ObjectDeserializer<HistogramGrouping.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<HistogramGrouping> _DESERIALIZER

Json deserializer for HistogramGrouping

Method Details

of

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

fields

public final List<String> fields()

Required - The set of fields that you wish to build histograms for. All fields specified must be some kind of numeric. Order does not matter.

API name: fields

interval

public final long interval()

Required - The interval of histogram buckets to be generated when rolling up. For example, a value of 5 creates buckets that are five units wide (0-5, 5-10, etc). Note that only one interval can be specified in the histogram group, meaning that all fields being grouped via the histogram must share the same interval.

API name: interval

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)

toString

public String toString()

Overrides:

toString in class Object

setupHistogramGroupingDeserializer

protected static void setupHistogramGroupingDeserializer(ObjectDeserializer<HistogramGrouping.Builder> op)