Package co.elastic.clients.elasticsearch._types.aggregations

Class AutoDateHistogramAggregation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase.AbstractBuilder<AutoDateHistogramAggregation.Builder>

co.elastic.clients.elasticsearch._types.aggregations.AutoDateHistogramAggregation.Builder

All Implemented Interfaces:

WithJson<AutoDateHistogramAggregation.Builder>, ObjectBuilder<AutoDateHistogramAggregation>

Enclosing class:

AutoDateHistogramAggregation

public static class AutoDateHistogramAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<AutoDateHistogramAggregation.Builder>
implements ObjectBuilder<AutoDateHistogramAggregation>

Builder for AutoDateHistogramAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AutoDateHistogramAggregation.Builder	buckets(Integer value)	The target number of buckets.
AutoDateHistogramAggregation	build()	Builds a AutoDateHistogramAggregation.
final AutoDateHistogramAggregation.Builder	field(String value)	The field on which to run the aggregation.
final AutoDateHistogramAggregation.Builder	format(String value)	The date format used to format key_as_string in the response.
final AutoDateHistogramAggregation.Builder	minimumInterval(MinimumInterval value)	The minimum rounding interval.
final AutoDateHistogramAggregation.Builder	missing(DateTime value)	The value to apply to documents that do not have a value.
final AutoDateHistogramAggregation.Builder	offset(String value)	Time zone specified as a ISO 8601 UTC offset.
final AutoDateHistogramAggregation.Builder	params(String key, JsonData value)	API name: params
final AutoDateHistogramAggregation.Builder	params(Map<String,JsonData> map)	API name: params
final AutoDateHistogramAggregation.Builder	script(Script value)	API name: script
final AutoDateHistogramAggregation.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
protected AutoDateHistogramAggregation.Builder	self()
final AutoDateHistogramAggregation.Builder	timeZone(String value)	Time zone ID.

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

buckets

public final AutoDateHistogramAggregation.Builder buckets(@Nullable
 Integer value)

The target number of buckets.

API name: buckets

field

public final AutoDateHistogramAggregation.Builder field(@Nullable
 String value)

The field on which to run the aggregation.

API name: field

format

public final AutoDateHistogramAggregation.Builder format(@Nullable
 String value)

The date format used to format key_as_string in the response. If no format is specified, the first date format specified in the field mapping is used.

API name: format

minimumInterval

public final AutoDateHistogramAggregation.Builder minimumInterval(@Nullable
 MinimumInterval value)

The minimum rounding interval. This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than minimum_interval.

API name: minimum_interval

missing

public final AutoDateHistogramAggregation.Builder missing(@Nullable
 DateTime value)

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

API name: missing

offset

public final AutoDateHistogramAggregation.Builder offset(@Nullable
 String value)

Time zone specified as a ISO 8601 UTC offset.

API name: offset

params

public final AutoDateHistogramAggregation.Builder params(Map<String,JsonData> map)

API name: params

Adds all entries of map to params.

params

public final AutoDateHistogramAggregation.Builder params(String key,
 JsonData value)

API name: params

Adds an entry to params.

script

public final AutoDateHistogramAggregation.Builder script(@Nullable
 Script value)

API name: script

script

public final AutoDateHistogramAggregation.Builder script(Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: script

timeZone

public final AutoDateHistogramAggregation.Builder timeZone(@Nullable
 String value)

Time zone ID.

API name: time_zone

self

protected AutoDateHistogramAggregation.Builder self()

Specified by:

self in class BucketAggregationBase.AbstractBuilder<AutoDateHistogramAggregation.Builder>

build

public AutoDateHistogramAggregation build()

Builds a AutoDateHistogramAggregation.

Specified by:

build in interface ObjectBuilder<AutoDateHistogramAggregation>

Throws:

NullPointerException - if some of the required fields are null.