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<BuilderT>

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

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

All Implemented Interfaces:

ObjectBuilder<RangeAggregation>

Enclosing class:

RangeAggregation

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

Builder for RangeAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RangeAggregation	build()	Builds a RangeAggregation.
RangeAggregation.Builder	field(java.lang.String value)	API name: field
RangeAggregation.Builder	keyed(java.lang.Boolean value)	API name: keyed
RangeAggregation.Builder	missing(java.lang.Integer value)	API name: missing
RangeAggregation.Builder	ranges(java.util.function.Function<AggregationRange.Builder,ObjectBuilder<AggregationRange>> fn)	API name: ranges
RangeAggregation.Builder	ranges(java.util.List<AggregationRange> list)	API name: ranges
RangeAggregation.Builder	ranges(AggregationRange value, AggregationRange... values)	API name: ranges
RangeAggregation.Builder	script(java.util.function.Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
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, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

field

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

API name: field

missing

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

API name: missing

ranges

public final RangeAggregation.Builder ranges(java.util.List<AggregationRange> list)

API name: ranges

Adds all elements of list to ranges.

ranges

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

API name: ranges

Adds one or more values to ranges.

ranges

public final RangeAggregation.Builder ranges(java.util.function.Function<AggregationRange.Builder,ObjectBuilder<AggregationRange>> fn)

API name: ranges

Adds a value to ranges using a builder lambda.

script

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

API name: script

script

public final RangeAggregation.Builder script(java.util.function.Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: script

keyed

public final RangeAggregation.Builder keyed(@Nullable
                                            java.lang.Boolean value)

API name: keyed

self

protected RangeAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<RangeAggregation.Builder>

build

public RangeAggregation build()

Builds a RangeAggregation.

Specified by:

build in interface ObjectBuilder<RangeAggregation>

Throws:

java.lang.NullPointerException - if some of the required fields are null.