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

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

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

All Implemented Interfaces:

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

Enclosing class:

DateHistogramAggregation

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

Builder for DateHistogramAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DateHistogramAggregation	build()	Builds a DateHistogramAggregation.
final DateHistogramAggregation.Builder	calendarInterval(CalendarInterval value)	API name: calendar_interval
DateHistogramAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DateHistogramAggregation.Builder	extendedBounds(Function<ExtendedBounds.Builder<FieldDateMath>,ObjectBuilder<ExtendedBounds<FieldDateMath>>> fn)	API name: extended_bounds
final DateHistogramAggregation.Builder	extendedBounds(ExtendedBounds<FieldDateMath> value)	API name: extended_bounds
final DateHistogramAggregation.Builder	field(String value)	API name: field
final DateHistogramAggregation.Builder	fixedInterval(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: fixed_interval
final DateHistogramAggregation.Builder	fixedInterval(Time value)	API name: fixed_interval
final DateHistogramAggregation.Builder	format(String value)	The date format used to format key_as_string in the response.
final DateHistogramAggregation.Builder	hardBounds(Function<ExtendedBounds.Builder<FieldDateMath>,ObjectBuilder<ExtendedBounds<FieldDateMath>>> fn)	API name: hard_bounds
final DateHistogramAggregation.Builder	hardBounds(ExtendedBounds<FieldDateMath> value)	API name: hard_bounds
final DateHistogramAggregation.Builder	interval(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: interval
final DateHistogramAggregation.Builder	interval(Time value)	API name: interval
final DateHistogramAggregation.Builder	keyed(Boolean value)	Set to true to associate a unique string key with each bucket and return the ranges as a hash rather than an array.
final DateHistogramAggregation.Builder	minDocCount(Integer value)	Only returns buckets that have min_doc_count number of documents.
final DateHistogramAggregation.Builder	missing(String value)	API name: missing
final DateHistogramAggregation.Builder	offset(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: offset
final DateHistogramAggregation.Builder	offset(Time value)	API name: offset
final DateHistogramAggregation.Builder	order(Function<HistogramOrder.Builder,ObjectBuilder<HistogramOrder>> fn)	API name: order
final DateHistogramAggregation.Builder	order(HistogramOrder value)	API name: order
final DateHistogramAggregation.Builder	params(String key, JsonData value)	API name: params
final DateHistogramAggregation.Builder	params(Map<String,JsonData> map)	API name: params
final DateHistogramAggregation.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
final DateHistogramAggregation.Builder	script(Script value)	API name: script
protected DateHistogramAggregation.Builder	self()
final DateHistogramAggregation.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 DateHistogramAggregation.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<DateHistogramAggregation.Builder,DateHistogramAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected DateHistogramAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<DateHistogramAggregation.Builder>

calendarInterval

@Nonnull
public final DateHistogramAggregation.Builder calendarInterval(@Nullable
 CalendarInterval value)

API name: calendar_interval

extendedBounds

@Nonnull
public final DateHistogramAggregation.Builder extendedBounds(@Nullable
 ExtendedBounds<FieldDateMath> value)

API name: extended_bounds

extendedBounds

@Nonnull
public final DateHistogramAggregation.Builder extendedBounds(Function<ExtendedBounds.Builder<FieldDateMath>,ObjectBuilder<ExtendedBounds<FieldDateMath>>> fn)

API name: extended_bounds

field

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

API name: field

fixedInterval

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

API name: fixed_interval

fixedInterval

@Nonnull
public final DateHistogramAggregation.Builder fixedInterval(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: fixed_interval

format

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

The date format used to format key_as_string in the response. If no format is specified, the first date format specified in the field mapping is used.

API name: format

hardBounds

@Nonnull
public final DateHistogramAggregation.Builder hardBounds(@Nullable
 ExtendedBounds<FieldDateMath> value)

API name: hard_bounds

hardBounds

@Nonnull
public final DateHistogramAggregation.Builder hardBounds(Function<ExtendedBounds.Builder<FieldDateMath>,ObjectBuilder<ExtendedBounds<FieldDateMath>>> fn)

API name: hard_bounds

interval

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

API name: interval

interval

@Nonnull
public final DateHistogramAggregation.Builder interval(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: interval

keyed

@Nonnull
public final DateHistogramAggregation.Builder keyed(@Nullable
 Boolean value)

Set to true to associate a unique string key with each bucket and return the ranges as a hash rather than an array.

API name: keyed

minDocCount

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

Only returns buckets that have min_doc_count number of documents. By default, all buckets between the first bucket that matches documents and the last one are returned.

API name: min_doc_count

missing

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

API name: missing

offset

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

API name: offset

offset

@Nonnull
public final DateHistogramAggregation.Builder offset(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: offset

order

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

API name: order

order

@Nonnull
public final DateHistogramAggregation.Builder order(Function<HistogramOrder.Builder,ObjectBuilder<HistogramOrder>> fn)

API name: order

params

@Nonnull
public final DateHistogramAggregation.Builder params(Map<String,JsonData> map)

API name: params

Adds all elements of map to params.

params

@Nonnull
public final DateHistogramAggregation.Builder params(String key,
 JsonData value)

API name: params

Adds an entry to params.

script

@Nonnull
public final DateHistogramAggregation.Builder script(@Nullable
 Script value)

API name: script

script

@Nonnull
public final DateHistogramAggregation.Builder script(Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: script

timeZone

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

API name: time_zone

build

@Nonnull
public DateHistogramAggregation build()

Builds a DateHistogramAggregation.

Specified by:

build in interface ObjectBuilder<DateHistogramAggregation>

Throws:

NullPointerException - if some of the required fields are null.