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

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

org.opensearch.client.opensearch._types.aggregations.DateRangeAggregation.Builder

All Implemented Interfaces:

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.
DateRangeAggregation.Builder	field(java.lang.String value)	API name: field
DateRangeAggregation.Builder	format(java.lang.String value)	API name: format
DateRangeAggregation.Builder	keyed(java.lang.Boolean value)	API name: keyed
DateRangeAggregation.Builder	missing(java.util.function.Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: missing
DateRangeAggregation.Builder	missing(FieldValue value)	API name: missing
DateRangeAggregation.Builder	ranges(java.util.function.Function<DateRangeExpression.Builder,ObjectBuilder<DateRangeExpression>> fn)	API name: ranges
DateRangeAggregation.Builder	ranges(java.util.List<DateRangeExpression> list)	API name: ranges
DateRangeAggregation.Builder	ranges(DateRangeExpression value, DateRangeExpression... values)	API name: ranges
protected DateRangeAggregation.Builder	self()
DateRangeAggregation.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

field

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

API name: field

format

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

API name: format

missing

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

API name: missing

missing

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

API name: missing

ranges

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

API name: ranges

Adds all elements of list to ranges.

ranges

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

API name: ranges

Adds one or more values to ranges.

ranges

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

API name: ranges

Adds a value to ranges using a builder lambda.

timeZone

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

API name: time_zone

keyed

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

API name: keyed

self

protected DateRangeAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<DateRangeAggregation.Builder>

build

public DateRangeAggregation build()

Builds a DateRangeAggregation.

Specified by:

build in interface ObjectBuilder<DateRangeAggregation>

Throws:

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