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

Class DateHistogramBucket.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.MultiBucketBase.AbstractBuilder<DateHistogramBucket.Builder>

org.opensearch.client.opensearch._types.aggregations.DateHistogramBucket.Builder

All Implemented Interfaces:

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

Enclosing class:

DateHistogramBucket

public static class DateHistogramBucket.Builder
extends MultiBucketBase.AbstractBuilder<DateHistogramBucket.Builder>
implements CopyableBuilder<DateHistogramBucket.Builder,DateHistogramBucket>

Builder for DateHistogramBucket.

Field Summary

Fields inherited from class org.opensearch.client.opensearch._types.aggregations.MultiBucketBase.AbstractBuilder

aggregations

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DateHistogramBucket	build()	Builds a DateHistogramBucket.
DateHistogramBucket.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DateHistogramBucket.Builder	key(long value)	Required - API name: key
final DateHistogramBucket.Builder	keyAsString(String value)	API name: key_as_string
protected DateHistogramBucket.Builder	self()

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

aggregations, aggregations, aggregations, docCount

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 DateHistogramBucket.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<DateHistogramBucket.Builder,DateHistogramBucket>

Returns:

a new builder instance.

self

@Nonnull
protected DateHistogramBucket.Builder self()

Specified by:

self in class MultiBucketBase.AbstractBuilder<DateHistogramBucket.Builder>

key

@Nonnull
public final DateHistogramBucket.Builder key(long value)

Required - API name: key

keyAsString

@Nonnull
public final DateHistogramBucket.Builder keyAsString(@Nullable
 String value)

API name: key_as_string

build

@Nonnull
public DateHistogramBucket build()

Builds a DateHistogramBucket.

Specified by:

build in interface ObjectBuilder<DateHistogramBucket>

Throws:

NullPointerException - if some of the required fields are null.