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)	Calendar-aware interval.
final DateHistogramAggregation.Builder	extendedBounds(ExtendedBounds<FieldDateMath> value)	Enables extending the bounds of the histogram beyond the data itself.
final DateHistogramAggregation.Builder	extendedBounds(Function<ExtendedBounds.Builder<FieldDateMath>,ObjectBuilder<ExtendedBounds<FieldDateMath>>> fn)	Enables extending the bounds of the histogram beyond the data itself.
final DateHistogramAggregation.Builder	field(String value)	The date field whose values are use to build a histogram.
final DateHistogramAggregation.Builder	fixedInterval(Time value)	Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar.
final DateHistogramAggregation.Builder	fixedInterval(Function<Time.Builder,ObjectBuilder<Time>> fn)	Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar.
final DateHistogramAggregation.Builder	format(String value)	The date format used to format key_as_string in the response.
final DateHistogramAggregation.Builder	hardBounds(ExtendedBounds<FieldDateMath> value)	Limits the histogram to specified bounds.
final DateHistogramAggregation.Builder	hardBounds(Function<ExtendedBounds.Builder<FieldDateMath>,ObjectBuilder<ExtendedBounds<FieldDateMath>>> fn)	Limits the histogram to specified 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)	Set to true to associate a unique string key with each bucket and return the ranges as a hash rather than an array.
final DateHistogramAggregation.Builder	minDocCount(Integer value)	Only returns buckets that have min_doc_count number of documents.
final DateHistogramAggregation.Builder	missing(DateTime value)	The value to apply to documents that do not have a value.
final DateHistogramAggregation.Builder	offset(Time value)	Changes the start value of each bucket by the specified positive (+) or negative offset (-) duration.
final DateHistogramAggregation.Builder	offset(Function<Time.Builder,ObjectBuilder<Time>> fn)	Changes the start value of each bucket by the specified positive (+) or negative offset (-) duration.
final DateHistogramAggregation.Builder	order(NamedValue<SortOrder> value, NamedValue<SortOrder>... values)	The sort order of the returned buckets.
final DateHistogramAggregation.Builder	order(List<NamedValue<SortOrder>> list)	The sort order of the returned buckets.
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)	Time zone used for bucketing and rounding.

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)

Calendar-aware interval. Can be specified using the unit name, such as month, or as a single unit quantity, such as 1M.

API name: calendar_interval

extendedBounds

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

Enables extending the bounds of the histogram beyond the data itself.

API name: extended_bounds

extendedBounds

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

Enables extending the bounds of the histogram beyond the data itself.

API name: extended_bounds

hardBounds

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

Limits the histogram to specified bounds.

API name: hard_bounds

hardBounds

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

Limits the histogram to specified bounds.

API name: hard_bounds

field

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

The date field whose values are use to build a histogram.

API name: field

fixedInterval

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

Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar.

API name: fixed_interval

fixedInterval

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

Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar.

API name: fixed_interval

format

public final DateHistogramAggregation.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

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)

Only returns buckets that have min_doc_count number of documents. By default, all buckets between the first bucket that matches documents and the last one are returned.

API name: min_doc_count

missing

public final DateHistogramAggregation.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 DateHistogramAggregation.Builder offset(@Nullable
 Time value)

Changes the start value of each bucket by the specified positive (+) or negative offset (-) duration.

API name: offset

offset

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

Changes the start value of each bucket by the specified positive (+) or negative offset (-) duration.

API name: offset

order

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

The sort order of the returned buckets.

API name: order

Adds all elements of list to order.

order

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

The sort order of the returned buckets.

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)

Time zone used for bucketing and rounding. Defaults to Coordinated Universal Time (UTC).

API name: time_zone

keyed

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

Set to true to associate a unique string key with each bucket and return the ranges as a hash rather than an array.

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.