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

Class IpRangeAggregation.Builder

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.Aggregation.AbstractBuilder<BuilderT>

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

org.opensearch.client.opensearch._types.aggregations.IpRangeAggregation.Builder

All Implemented Interfaces:

ObjectBuilder<IpRangeAggregation>

Enclosing class:

IpRangeAggregation

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

Builder for IpRangeAggregation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IpRangeAggregation.Builder	addRanges(java.util.function.Function<IpRangeAggregationRange.Builder,ObjectBuilder<IpRangeAggregationRange>> fn)	Add a value to ranges(List), creating the list if needed.
IpRangeAggregation.Builder	addRanges(IpRangeAggregationRange value)	Add a value to ranges(List), creating the list if needed.
IpRangeAggregation	build()	Builds a IpRangeAggregation.
IpRangeAggregation.Builder	field(java.lang.String value)	API name: field
IpRangeAggregation.Builder	ranges(java.util.function.Function<IpRangeAggregationRange.Builder,ObjectBuilder<IpRangeAggregationRange>> fn)	Set ranges(List) to a singleton list.
IpRangeAggregation.Builder	ranges(java.util.List<IpRangeAggregationRange> value)	API name: ranges
IpRangeAggregation.Builder	ranges(IpRangeAggregationRange... value)	API name: ranges
protected IpRangeAggregation.Builder	self()

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

aggregations, aggregations, putAggregations, putAggregations

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

meta, name, putMeta

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

field

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

API name: field

ranges

public IpRangeAggregation.Builder ranges(@Nullable java.util.List<IpRangeAggregationRange> value)

API name: ranges

ranges

public IpRangeAggregation.Builder ranges(IpRangeAggregationRange... value)

API name: ranges

addRanges

public IpRangeAggregation.Builder addRanges(IpRangeAggregationRange value)

Add a value to ranges(List), creating the list if needed.

ranges

public IpRangeAggregation.Builder ranges(java.util.function.Function<IpRangeAggregationRange.Builder,ObjectBuilder<IpRangeAggregationRange>> fn)

Set ranges(List) to a singleton list.

addRanges

public IpRangeAggregation.Builder addRanges(java.util.function.Function<IpRangeAggregationRange.Builder,ObjectBuilder<IpRangeAggregationRange>> fn)

Add a value to ranges(List), creating the list if needed.

self

protected IpRangeAggregation.Builder self()

Specified by:

self in class Aggregation.AbstractBuilder<IpRangeAggregation.Builder>

build

public IpRangeAggregation build()

Builds a IpRangeAggregation.

Specified by:

build in interface ObjectBuilder<IpRangeAggregation>

Throws:

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