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

Class IpRangeAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

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

All Implemented Interfaces:

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

Enclosing class:

IpRangeAggregation

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

Builder for IpRangeAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IpRangeAggregation	build()	Builds a IpRangeAggregation.
IpRangeAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IpRangeAggregation.Builder	field(String value)	API name: field
final IpRangeAggregation.Builder	ranges(Function<IpRangeAggregationRange.Builder,ObjectBuilder<IpRangeAggregationRange>> fn)	Array of IP ranges.
final IpRangeAggregation.Builder	ranges(List<IpRangeAggregationRange> list)	Array of IP ranges.
final IpRangeAggregation.Builder	ranges(IpRangeAggregationRange value, IpRangeAggregationRange... values)	Array of IP ranges.
protected IpRangeAggregation.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 IpRangeAggregation.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<IpRangeAggregation.Builder,IpRangeAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected IpRangeAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<IpRangeAggregation.Builder>

field

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

API name: field

ranges

@Nonnull
public final IpRangeAggregation.Builder ranges(List<IpRangeAggregationRange> list)

Array of IP ranges.

API name: ranges

Adds all elements of list to ranges.

ranges

@Nonnull
public final IpRangeAggregation.Builder ranges(IpRangeAggregationRange value,
 IpRangeAggregationRange... values)

Array of IP ranges.

API name: ranges

Adds one or more values to ranges.

ranges

@Nonnull
public final IpRangeAggregation.Builder ranges(Function<IpRangeAggregationRange.Builder,ObjectBuilder<IpRangeAggregationRange>> fn)

Array of IP ranges.

API name: ranges

Adds a value to ranges using a builder lambda.

build

@Nonnull
public IpRangeAggregation build()

Builds a IpRangeAggregation.

Specified by:

build in interface ObjectBuilder<IpRangeAggregation>

Throws:

NullPointerException - if some of the required fields are null.