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

Class AggregationRange.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationRange.Builder

All Implemented Interfaces:

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

Enclosing class:

AggregationRange

public static class AggregationRange.Builder
extends ObjectBuilderBase
implements CopyableBuilder<AggregationRange.Builder,AggregationRange>

Builder for AggregationRange.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AggregationRange	build()	Builds a AggregationRange.
AggregationRange.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AggregationRange.Builder	from(JsonData value)	Start of the range (inclusive).
final AggregationRange.Builder	key(String value)	Custom key to return the range with.
final AggregationRange.Builder	to(JsonData value)	End of the range (exclusive).

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

Returns:

a new builder instance.

from

@Nonnull
public final AggregationRange.Builder from(@Nullable
 JsonData value)

Start of the range (inclusive).

API name: from

key

@Nonnull
public final AggregationRange.Builder key(@Nullable
 String value)

Custom key to return the range with.

API name: key

to

@Nonnull
public final AggregationRange.Builder to(@Nullable
 JsonData value)

End of the range (exclusive).

API name: to

build

@Nonnull
public AggregationRange build()

Builds a AggregationRange.

Specified by:

build in interface ObjectBuilder<AggregationRange>

Throws:

NullPointerException - if some of the required fields are null.