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

Class DateHistogramAggregation.Builder

java.lang.Object

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

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
DateHistogramAggregation	build()	Builds a DateHistogramAggregation.
DateHistogramAggregation.Builder	calendarInterval(jakarta.json.JsonValue value)	API name: calendar_interval
DateHistogramAggregation.Builder	extendedBounds(java.util.function.Function<ExtendedBounds.Builder<jakarta.json.JsonValue>,ObjectBuilder<ExtendedBounds<jakarta.json.JsonValue>>> fn)	API name: extended_bounds
DateHistogramAggregation.Builder	extendedBounds(ExtendedBounds<jakarta.json.JsonValue> value)	API name: extended_bounds
DateHistogramAggregation.Builder	field(java.lang.String value)	API name: field
DateHistogramAggregation.Builder	fixedInterval(jakarta.json.JsonValue value)	API name: fixed_interval
DateHistogramAggregation.Builder	format(java.lang.String value)	API name: format
DateHistogramAggregation.Builder	hardBounds(java.util.function.Function<ExtendedBounds.Builder<jakarta.json.JsonValue>,ObjectBuilder<ExtendedBounds<jakarta.json.JsonValue>>> fn)	API name: hard_bounds
DateHistogramAggregation.Builder	hardBounds(ExtendedBounds<jakarta.json.JsonValue> value)	API name: hard_bounds
DateHistogramAggregation.Builder	interval(jakarta.json.JsonValue value)	API name: interval
DateHistogramAggregation.Builder	minDocCount(java.lang.Number value)	API name: min_doc_count
DateHistogramAggregation.Builder	missing(java.lang.String value)	API name: missing
DateHistogramAggregation.Builder	offset(jakarta.json.JsonValue 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.util.Map<java.lang.String,jakarta.json.JsonValue> value)	API name: params
DateHistogramAggregation.Builder	putParams(java.lang.String key, jakarta.json.JsonValue value)	Add a key/value to params(Map), creating the map if needed.
DateHistogramAggregation.Builder	script(jakarta.json.JsonValue 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.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

calendarInterval

public DateHistogramAggregation.Builder calendarInterval(@Nullable jakarta.json.JsonValue value)

API name: calendar_interval

extendedBounds

public DateHistogramAggregation.Builder extendedBounds(@Nullable ExtendedBounds<jakarta.json.JsonValue> value)

API name: extended_bounds

extendedBounds

public DateHistogramAggregation.Builder extendedBounds(java.util.function.Function<ExtendedBounds.Builder<jakarta.json.JsonValue>,ObjectBuilder<ExtendedBounds<jakarta.json.JsonValue>>> fn)

API name: extended_bounds

hardBounds

public DateHistogramAggregation.Builder hardBounds(@Nullable ExtendedBounds<jakarta.json.JsonValue> value)

API name: hard_bounds

hardBounds

public DateHistogramAggregation.Builder hardBounds(java.util.function.Function<ExtendedBounds.Builder<jakarta.json.JsonValue>,ObjectBuilder<ExtendedBounds<jakarta.json.JsonValue>>> fn)

API name: hard_bounds

field

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

API name: field

fixedInterval

public DateHistogramAggregation.Builder fixedInterval(@Nullable jakarta.json.JsonValue value)

API name: fixed_interval

format

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

API name: format

interval

public DateHistogramAggregation.Builder interval(@Nullable jakarta.json.JsonValue value)

API name: interval

minDocCount

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

API name: min_doc_count

missing

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

API name: missing

offset

public DateHistogramAggregation.Builder offset(@Nullable jakarta.json.JsonValue value)

API name: offset

order

public DateHistogramAggregation.Builder order(@Nullable HistogramOrder value)

API name: order

order

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

API name: order

params

public DateHistogramAggregation.Builder params(@Nullable java.util.Map<java.lang.String,jakarta.json.JsonValue> value)

API name: params

putParams

public DateHistogramAggregation.Builder putParams(java.lang.String key, jakarta.json.JsonValue value)

Add a key/value to params(Map), creating the map if needed.

script

public DateHistogramAggregation.Builder script(@Nullable jakarta.json.JsonValue value)

API name: script

timeZone

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

API name: time_zone

self

protected DateHistogramAggregation.Builder self()

Specified by:

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