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

Class DateRangeAggregation.Builder

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.Aggregation.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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DateRangeAggregation.Builder	addRanges(java.util.function.Function<DateRangeExpression.Builder,ObjectBuilder<DateRangeExpression>> fn)	Add a value to ranges(List), creating the list if needed.
DateRangeAggregation.Builder	addRanges(DateRangeExpression value)	Add a value to ranges(List), creating the list if needed.
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	missing(jakarta.json.JsonValue value)	API name: missing
DateRangeAggregation.Builder	ranges(java.util.function.Function<DateRangeExpression.Builder,ObjectBuilder<DateRangeExpression>> fn)	Set ranges(List) to a singleton list.
DateRangeAggregation.Builder	ranges(java.util.List<DateRangeExpression> value)	API name: ranges
DateRangeAggregation.Builder	ranges(DateRangeExpression... value)	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.BucketAggregationBase.AbstractBuilder

aggregations, aggregations, putAggregations, putAggregations

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

meta, name, putMeta

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

field

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

API name: field

format

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

API name: format

missing

public DateRangeAggregation.Builder missing(@Nullable jakarta.json.JsonValue value)

API name: missing

ranges

public DateRangeAggregation.Builder ranges(@Nullable java.util.List<DateRangeExpression> value)

API name: ranges

ranges

public DateRangeAggregation.Builder ranges(DateRangeExpression... value)

API name: ranges

addRanges

public DateRangeAggregation.Builder addRanges(DateRangeExpression value)

Add a value to ranges(List), creating the list if needed.

ranges

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

Set ranges(List) to a singleton list.

addRanges

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

Add a value to ranges(List), creating the list if needed.

timeZone

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

API name: time_zone

self

protected DateRangeAggregation.Builder self()

Specified by:

self in class Aggregation.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.