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

Class IpRangeAggregationRange.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.IpRangeAggregationRange.Builder

All Implemented Interfaces:

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

Enclosing class:

IpRangeAggregationRange

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

Builder for IpRangeAggregationRange.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IpRangeAggregationRange	build()	Builds a IpRangeAggregationRange.
IpRangeAggregationRange.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IpRangeAggregationRange.Builder	from(String value)	Start of the range.
final IpRangeAggregationRange.Builder	mask(String value)	IP range defined as a CIDR mask.
final IpRangeAggregationRange.Builder	to(String value)	End of the range.

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

Returns:

a new builder instance.

from

@Nonnull
public final IpRangeAggregationRange.Builder from(@Nullable
 String value)

Start of the range.

API name: from

mask

@Nonnull
public final IpRangeAggregationRange.Builder mask(@Nullable
 String value)

IP range defined as a CIDR mask.

API name: mask

to

@Nonnull
public final IpRangeAggregationRange.Builder to(@Nullable
 String value)

End of the range.

API name: to

build

@Nonnull
public IpRangeAggregationRange build()

Builds a IpRangeAggregationRange.

Specified by:

build in interface ObjectBuilder<IpRangeAggregationRange>

Throws:

NullPointerException - if some of the required fields are null.