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

Class RangeAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

org.opensearch.client.opensearch._types.aggregations.RangeAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

RangeAggregation

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

Builder for RangeAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RangeAggregation	build()	Builds a RangeAggregation.
RangeAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RangeAggregation.Builder	field(String value)	API name: field
final RangeAggregation.Builder	format(String value)	API name: format
final RangeAggregation.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 RangeAggregation.Builder	missing(Integer value)	The value to apply to documents that do not have a value.
final RangeAggregation.Builder	ranges(Function<AggregationRange.Builder,ObjectBuilder<AggregationRange>> fn)	An array of ranges used to bucket documents.
final RangeAggregation.Builder	ranges(List<AggregationRange> list)	An array of ranges used to bucket documents.
final RangeAggregation.Builder	ranges(AggregationRange value, AggregationRange... values)	An array of ranges used to bucket documents.
final RangeAggregation.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
final RangeAggregation.Builder	script(Script value)	API name: script
protected RangeAggregation.Builder	self()

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

Returns:

a new builder instance.

self

@Nonnull
protected RangeAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<RangeAggregation.Builder>

field

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

API name: field

format

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

API name: format

keyed

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

missing

@Nonnull
public final RangeAggregation.Builder missing(@Nullable
 Integer value)

The value to apply to documents that do not have a value. By default, documents without a value are ignored.

API name: missing

ranges

@Nonnull
public final RangeAggregation.Builder ranges(List<AggregationRange> list)

An array of ranges used to bucket documents.

API name: ranges

Adds all elements of list to ranges.

ranges

@Nonnull
public final RangeAggregation.Builder ranges(AggregationRange value,
 AggregationRange... values)

An array of ranges used to bucket documents.

API name: ranges

Adds one or more values to ranges.

ranges

@Nonnull
public final RangeAggregation.Builder ranges(Function<AggregationRange.Builder,ObjectBuilder<AggregationRange>> fn)

An array of ranges used to bucket documents.

API name: ranges

Adds a value to ranges using a builder lambda.

script

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

API name: script

script

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

API name: script

build

@Nonnull
public RangeAggregation build()

Builds a RangeAggregation.

Specified by:

build in interface ObjectBuilder<RangeAggregation>

Throws:

NullPointerException - if some of the required fields are null.