Package co.elastic.clients.elasticsearch.rollup

Class Groupings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<Groupings.Builder>

co.elastic.clients.elasticsearch.rollup.Groupings.Builder

All Implemented Interfaces:

WithJson<Groupings.Builder>, ObjectBuilder<Groupings>

Enclosing class:

Groupings

public static class Groupings.Builder
extends WithJsonObjectBuilderBase<Groupings.Builder>
implements ObjectBuilder<Groupings>

Builder for Groupings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Groupings	build()	Builds a Groupings.
final Groupings.Builder	dateHistogram(DateHistogramGrouping value)	A date histogram group aggregates a date field into time-based buckets.
final Groupings.Builder	dateHistogram(Function<DateHistogramGrouping.Builder,ObjectBuilder<DateHistogramGrouping>> fn)	A date histogram group aggregates a date field into time-based buckets.
final Groupings.Builder	histogram(HistogramGrouping value)	The histogram group aggregates one or more numeric fields into numeric histogram intervals.
final Groupings.Builder	histogram(Function<HistogramGrouping.Builder,ObjectBuilder<HistogramGrouping>> fn)	The histogram group aggregates one or more numeric fields into numeric histogram intervals.
protected Groupings.Builder	self()
final Groupings.Builder	terms(TermsGrouping value)	The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point.
final Groupings.Builder	terms(Function<TermsGrouping.Builder,ObjectBuilder<TermsGrouping>> fn)	The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

dateHistogram

public final Groupings.Builder dateHistogram(@Nullable
 DateHistogramGrouping value)

A date histogram group aggregates a date field into time-based buckets. This group is mandatory; you currently cannot roll up documents without a timestamp and a date_histogram group.

API name: date_histogram

dateHistogram

public final Groupings.Builder dateHistogram(Function<DateHistogramGrouping.Builder,ObjectBuilder<DateHistogramGrouping>> fn)

A date histogram group aggregates a date field into time-based buckets. This group is mandatory; you currently cannot roll up documents without a timestamp and a date_histogram group.

API name: date_histogram

histogram

public final Groupings.Builder histogram(@Nullable
 HistogramGrouping value)

The histogram group aggregates one or more numeric fields into numeric histogram intervals.

API name: histogram

histogram

public final Groupings.Builder histogram(Function<HistogramGrouping.Builder,ObjectBuilder<HistogramGrouping>> fn)

The histogram group aggregates one or more numeric fields into numeric histogram intervals.

API name: histogram

terms

public final Groupings.Builder terms(@Nullable
 TermsGrouping value)

The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point. The indexer enumerates and stores all values of a field for each time-period. This can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse.

API name: terms

terms

public final Groupings.Builder terms(Function<TermsGrouping.Builder,ObjectBuilder<TermsGrouping>> fn)

The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point. The indexer enumerates and stores all values of a field for each time-period. This can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse.

API name: terms

self

protected Groupings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<Groupings.Builder>

build

public Groupings build()

Builds a Groupings.

Specified by:

build in interface ObjectBuilder<Groupings>

Throws:

NullPointerException - if some of the required fields are null.