Package org.opensearch.client.opensearch._types.aggregations

Class DateHistogramAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<DateHistogramAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.DateHistogramAggregation.Builder

All Implemented Interfaces:

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.
DateHistogramAggregation.Builder	calendarInterval(CalendarInterval value)	API name: calendar_interval
DateHistogramAggregation.Builder	extendedBounds(java.util.function.Function<ExtendedBounds.Builder<FieldDateMath>,ObjectBuilder<ExtendedBounds<FieldDateMath>>> fn)	API name: extended_bounds
DateHistogramAggregation.Builder	extendedBounds(ExtendedBounds<FieldDateMath> value)	API name: extended_bounds
DateHistogramAggregation.Builder	field(java.lang.String value)	API name: field
DateHistogramAggregation.Builder	fixedInterval(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: fixed_interval
DateHistogramAggregation.Builder	fixedInterval(Time value)	API name: fixed_interval
DateHistogramAggregation.Builder	format(java.lang.String value)	API name: format
DateHistogramAggregation.Builder	hardBounds(java.util.function.Function<ExtendedBounds.Builder<FieldDateMath>,ObjectBuilder<ExtendedBounds<FieldDateMath>>> fn)	API name: hard_bounds
DateHistogramAggregation.Builder	hardBounds(ExtendedBounds<FieldDateMath> value)	API name: hard_bounds
DateHistogramAggregation.Builder	interval(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: interval
DateHistogramAggregation.Builder	interval(Time value)	API name: interval
DateHistogramAggregation.Builder	keyed(java.lang.Boolean value)	API name: keyed
DateHistogramAggregation.Builder	minDocCount(java.lang.Integer value)	API name: min_doc_count
DateHistogramAggregation.Builder	missing(java.lang.String value)	API name: missing
DateHistogramAggregation.Builder	offset(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: offset
DateHistogramAggregation.Builder	offset(Time value)	API name: offset
DateHistogramAggregation.Builder	order(java.util.function.Function<HistogramOrder.Builder,ObjectBuilder<HistogramOrder>> fn)	API name: order
DateHistogramAggregation.Builder	order(HistogramOrder value)	API name: order
DateHistogramAggregation.Builder	params(java.lang.String key, JsonData value)	API name: params
DateHistogramAggregation.Builder	params(java.util.Map<java.lang.String,JsonData> map)	API name: params
DateHistogramAggregation.Builder	script(java.util.function.Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
DateHistogramAggregation.Builder	script(Script value)	API name: script
protected DateHistogramAggregation.Builder	self()
DateHistogramAggregation.Builder	timeZone(java.lang.String value)	API name: time_zone

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder

meta, meta, name

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

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(java.util.function.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(java.util.function.Function<ExtendedBounds.Builder<FieldDateMath>,ObjectBuilder<ExtendedBounds<FieldDateMath>>> fn)

API name: hard_bounds

field

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

API name: field

fixedInterval

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

API name: fixed_interval

fixedInterval

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

API name: fixed_interval

format

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

API name: format

interval

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

API name: interval

interval

public final DateHistogramAggregation.Builder interval(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: interval

minDocCount

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

API name: min_doc_count

missing

public final DateHistogramAggregation.Builder missing(@Nullable
                                                      java.lang.String value)

API name: missing

offset

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

API name: offset

offset

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

API name: offset

order

public final DateHistogramAggregation.Builder order(@Nullable
                                                    HistogramOrder value)

API name: order

order

public final DateHistogramAggregation.Builder order(java.util.function.Function<HistogramOrder.Builder,ObjectBuilder<HistogramOrder>> fn)

API name: order

params

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

API name: params

Adds all entries of map to params.

params

public final DateHistogramAggregation.Builder params(java.lang.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(java.util.function.Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: script

timeZone

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

API name: time_zone

keyed

public final DateHistogramAggregation.Builder keyed(@Nullable
                                                    java.lang.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:

java.lang.NullPointerException - if some of the required fields are null.