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

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

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

All Implemented Interfaces:

WithJson<DateRangeAggregation.Builder>, ObjectBuilder<DateRangeAggregation>

Enclosing class:

DateRangeAggregation

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

Builder for DateRangeAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DateRangeAggregation	build()	Builds a DateRangeAggregation.
final DateRangeAggregation.Builder	field(String value)	The date field whose values are use to build ranges.
final DateRangeAggregation.Builder	format(String value)	The date format used to format from and to in the response.
final DateRangeAggregation.Builder	keyed(Boolean value)	Set to true to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.
final DateRangeAggregation.Builder	missing(boolean value)	The value to apply to documents that do not have a value.
final DateRangeAggregation.Builder	missing(double value)	The value to apply to documents that do not have a value.
final DateRangeAggregation.Builder	missing(long value)	The value to apply to documents that do not have a value.
final DateRangeAggregation.Builder	missing(FieldValue value)	The value to apply to documents that do not have a value.
final DateRangeAggregation.Builder	missing(String value)	The value to apply to documents that do not have a value.
final DateRangeAggregation.Builder	missing(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	The value to apply to documents that do not have a value.
final DateRangeAggregation.Builder	ranges(DateRangeExpression value, DateRangeExpression... values)	Array of date ranges.
final DateRangeAggregation.Builder	ranges(Function<DateRangeExpression.Builder,ObjectBuilder<DateRangeExpression>> fn)	Array of date ranges.
final DateRangeAggregation.Builder	ranges(List<DateRangeExpression> list)	Array of date ranges.
protected DateRangeAggregation.Builder	self()
final DateRangeAggregation.Builder	timeZone(String value)	Time zone used to convert dates from another time zone to UTC.

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

field

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

The date field whose values are use to build ranges.

API name: field

format

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

The date format used to format from and to in the response.

API name: format

missing

public final DateRangeAggregation.Builder missing(@Nullable
 FieldValue value)

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

API name: missing

missing

public final DateRangeAggregation.Builder missing(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

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

API name: missing

missing

public final DateRangeAggregation.Builder missing(String value)

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

API name: missing

missing

public final DateRangeAggregation.Builder missing(long value)

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

API name: missing

missing

public final DateRangeAggregation.Builder missing(double value)

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

API name: missing

missing

public final DateRangeAggregation.Builder missing(boolean value)

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

API name: missing

ranges

public final DateRangeAggregation.Builder ranges(List<DateRangeExpression> list)

Array of date ranges.

API name: ranges

Adds all elements of list to ranges.

ranges

public final DateRangeAggregation.Builder ranges(DateRangeExpression value,
 DateRangeExpression... values)

Array of date ranges.

API name: ranges

Adds one or more values to ranges.

ranges

public final DateRangeAggregation.Builder ranges(Function<DateRangeExpression.Builder,ObjectBuilder<DateRangeExpression>> fn)

Array of date ranges.

API name: ranges

Adds a value to ranges using a builder lambda.

timeZone

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

Time zone used to convert dates from another time zone to UTC.

API name: time_zone

keyed

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

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

API name: keyed

self

protected DateRangeAggregation.Builder self()

Specified by:

self in class BucketAggregationBase.AbstractBuilder<DateRangeAggregation.Builder>

build

public DateRangeAggregation build()

Builds a DateRangeAggregation.

Specified by:

build in interface ObjectBuilder<DateRangeAggregation>

Throws:

NullPointerException - if some of the required fields are null.