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

Class DateHistogramAggregation.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<DateHistogramAggregation.Builder>

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

All Implemented Interfaces:

WithJson<DateHistogramAggregation.Builder>, ObjectBuilder<DateHistogramAggregation>

Enclosing class:

DateHistogramAggregation

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

Builder for DateHistogramAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DateHistogramAggregation	build()	Builds a DateHistogramAggregation.
final DateHistogramAggregation.Builder	calendarInterval(CalendarInterval value)	API name: calendar_interval
final DateHistogramAggregation.Builder	extendedBounds(ExtendedBounds<FieldDateMath> value)	API name: extended_bounds
final DateHistogramAggregation.Builder	extendedBounds(Function<ExtendedBounds.Builder<FieldDateMath>,ObjectBuilder<ExtendedBounds<FieldDateMath>>> fn)	API name: extended_bounds
final DateHistogramAggregation.Builder	field(String value)	API name: field
final DateHistogramAggregation.Builder	fixedInterval(Time value)	API name: fixed_interval
final DateHistogramAggregation.Builder	fixedInterval(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: fixed_interval
final DateHistogramAggregation.Builder	format(String value)	API name: format
final DateHistogramAggregation.Builder	hardBounds(ExtendedBounds<FieldDateMath> value)	API name: hard_bounds
final DateHistogramAggregation.Builder	hardBounds(Function<ExtendedBounds.Builder<FieldDateMath>,ObjectBuilder<ExtendedBounds<FieldDateMath>>> fn)	API name: hard_bounds
final DateHistogramAggregation.Builder	interval(Time value)	Deprecated. 7.2.0 use fixed_interval or calendar_interval
final DateHistogramAggregation.Builder	interval(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated. 7.2.0 use fixed_interval or calendar_interval
final DateHistogramAggregation.Builder	keyed(Boolean value)	API name: keyed
final DateHistogramAggregation.Builder	minDocCount(Integer value)	API name: min_doc_count
final DateHistogramAggregation.Builder	missing(DateTime value)	API name: missing
final DateHistogramAggregation.Builder	offset(Time value)	API name: offset
final DateHistogramAggregation.Builder	offset(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: offset
final DateHistogramAggregation.Builder	order(NamedValue<SortOrder> value, NamedValue<SortOrder>... values)	API name: order
final DateHistogramAggregation.Builder	order(List<NamedValue<SortOrder>> list)	API name: order
final DateHistogramAggregation.Builder	params(String key, JsonData value)	API name: params
final DateHistogramAggregation.Builder	params(Map<String,JsonData> map)	API name: params
final DateHistogramAggregation.Builder	script(Script value)	API name: script
final DateHistogramAggregation.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
protected DateHistogramAggregation.Builder	self()
final DateHistogramAggregation.Builder	timeZone(String value)	API name: time_zone

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder

meta, meta, name

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

calendarInterval

public final DateHistogramAggregation.Builder calendarInterval(@Nullable
 CalendarInterval value)

API name: calendar_interval

extendedBounds

public final DateHistogramAggregation.Builder extendedBounds(@Nullable
 ExtendedBounds<FieldDateMath> value)

API name: extended_bounds

extendedBounds

public final DateHistogramAggregation.Builder extendedBounds(Function<ExtendedBounds.Builder<FieldDateMath>,ObjectBuilder<ExtendedBounds<FieldDateMath>>> fn)

API name: extended_bounds

hardBounds

public final DateHistogramAggregation.Builder hardBounds(@Nullable
 ExtendedBounds<FieldDateMath> value)

API name: hard_bounds

hardBounds

public final DateHistogramAggregation.Builder hardBounds(Function<ExtendedBounds.Builder<FieldDateMath>,ObjectBuilder<ExtendedBounds<FieldDateMath>>> fn)

API name: hard_bounds

field

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

API name: field

fixedInterval

public final DateHistogramAggregation.Builder fixedInterval(@Nullable
 Time value)

API name: fixed_interval

fixedInterval

public final DateHistogramAggregation.Builder fixedInterval(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: fixed_interval

format

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

API name: format

interval

@Deprecated
public final DateHistogramAggregation.Builder interval(@Nullable
 Time value)

Deprecated.

7.2.0 use fixed_interval or calendar_interval

API name: interval

interval

@Deprecated
public final DateHistogramAggregation.Builder interval(Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

7.2.0 use fixed_interval or calendar_interval

API name: interval

minDocCount

public final DateHistogramAggregation.Builder minDocCount(@Nullable
 Integer value)

API name: min_doc_count

missing

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

API name: missing

offset

public final DateHistogramAggregation.Builder offset(@Nullable
 Time value)

API name: offset

offset

public final DateHistogramAggregation.Builder offset(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: offset

order

public final DateHistogramAggregation.Builder order(List<NamedValue<SortOrder>> list)

API name: order

Adds all elements of list to order.

order

public final DateHistogramAggregation.Builder order(NamedValue<SortOrder> value,
 NamedValue<SortOrder>... values)

API name: order

Adds one or more values to order.

params

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

API name: params

Adds all entries of map to params.

params

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

API name: params

Adds an entry to params.

script

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

API name: script

script

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

API name: script

timeZone

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

API name: time_zone

keyed

public final DateHistogramAggregation.Builder keyed(@Nullable
 Boolean value)

API name: keyed

self

protected DateHistogramAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<DateHistogramAggregation.Builder>

build

public DateHistogramAggregation build()

Builds a DateHistogramAggregation.

Specified by:

build in interface ObjectBuilder<DateHistogramAggregation>

Throws:

NullPointerException - if some of the required fields are null.