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

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

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

All Implemented Interfaces:

CopyableBuilder<DateRangeAggregation.Builder,DateRangeAggregation>, MutableBuilder<DateRangeAggregation.Builder,DateRangeAggregation>, ObjectBuilder<DateRangeAggregation>

Enclosing class:

DateRangeAggregation

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

Builder for DateRangeAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DateRangeAggregation	build()	Builds a DateRangeAggregation.
DateRangeAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DateRangeAggregation.Builder	field(String value)	API name: field
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(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: missing
final DateRangeAggregation.Builder	missing(FieldValue value)	API name: missing
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.
final DateRangeAggregation.Builder	ranges(DateRangeExpression value, DateRangeExpression... values)	Array of date ranges.
protected DateRangeAggregation.Builder	self()
final DateRangeAggregation.Builder	timeZone(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, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public DateRangeAggregation.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<DateRangeAggregation.Builder,DateRangeAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected DateRangeAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<DateRangeAggregation.Builder>

field

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

API name: field

format

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

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

API name: format

keyed

@Nonnull
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

missing

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

API name: missing

missing

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

API name: missing

ranges

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

Array of date ranges.

API name: ranges

Adds all elements of list to ranges.

ranges

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

Array of date ranges.

API name: ranges

Adds one or more values to ranges.

ranges

@Nonnull
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

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

API name: time_zone

build

@Nonnull
public DateRangeAggregation build()

Builds a DateRangeAggregation.

Specified by:

build in interface ObjectBuilder<DateRangeAggregation>

Throws:

NullPointerException - if some of the required fields are null.