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

Class AutoDateHistogramAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<AutoDateHistogramAggregation.Builder>

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

org.opensearch.client.opensearch._types.aggregations.AutoDateHistogramAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

AutoDateHistogramAggregation

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

Builder for AutoDateHistogramAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AutoDateHistogramAggregation.Builder	buckets(Integer value)	The target number of buckets.
AutoDateHistogramAggregation	build()	Builds a AutoDateHistogramAggregation.
AutoDateHistogramAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AutoDateHistogramAggregation.Builder	field(String value)	API name: field
final AutoDateHistogramAggregation.Builder	format(String value)	The date format used to format key_as_string in the response.
final AutoDateHistogramAggregation.Builder	minimumInterval(MinimumInterval value)	API name: minimum_interval
final AutoDateHistogramAggregation.Builder	missing(String value)	API name: missing
final AutoDateHistogramAggregation.Builder	offset(String value)	Time zone specified as a ISO 8601 UTC offset.
final AutoDateHistogramAggregation.Builder	params(String key, JsonData value)	API name: params
final AutoDateHistogramAggregation.Builder	params(Map<String,JsonData> map)	API name: params
final AutoDateHistogramAggregation.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
final AutoDateHistogramAggregation.Builder	script(Script value)	API name: script
protected AutoDateHistogramAggregation.Builder	self()
final AutoDateHistogramAggregation.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 AutoDateHistogramAggregation.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<AutoDateHistogramAggregation.Builder,AutoDateHistogramAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected AutoDateHistogramAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<AutoDateHistogramAggregation.Builder>

buckets

@Nonnull
public final AutoDateHistogramAggregation.Builder buckets(@Nullable
 Integer value)

The target number of buckets.

API name: buckets

field

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

API name: field

format

@Nonnull
public final AutoDateHistogramAggregation.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

minimumInterval

@Nonnull
public final AutoDateHistogramAggregation.Builder minimumInterval(@Nullable
 MinimumInterval value)

API name: minimum_interval

missing

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

API name: missing

offset

@Nonnull
public final AutoDateHistogramAggregation.Builder offset(@Nullable
 String value)

Time zone specified as a ISO 8601 UTC offset.

API name: offset

params

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

API name: params

Adds all elements of map to params.

params

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

API name: params

Adds an entry to params.

script

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

API name: script

script

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

API name: script

timeZone

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

API name: time_zone

build

@Nonnull
public AutoDateHistogramAggregation build()

Builds a AutoDateHistogramAggregation.

Specified by:

build in interface ObjectBuilder<AutoDateHistogramAggregation>

Throws:

NullPointerException - if some of the required fields are null.