Package co.elastic.clients.elasticsearch._types.aggregations

Class IpPrefixAggregation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase.AbstractBuilder<IpPrefixAggregation.Builder>

co.elastic.clients.elasticsearch._types.aggregations.IpPrefixAggregation.Builder

All Implemented Interfaces:

WithJson<IpPrefixAggregation.Builder>, ObjectBuilder<IpPrefixAggregation>

Enclosing class:

IpPrefixAggregation

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

Builder for IpPrefixAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IpPrefixAggregation.Builder	appendPrefixLength(Boolean value)	Defines whether the prefix length is appended to IP address keys in the response.
IpPrefixAggregation	build()	Builds a IpPrefixAggregation.
final IpPrefixAggregation.Builder	field(String value)	Required - The document IP address field to aggregation on.
final IpPrefixAggregation.Builder	isIpv6(Boolean value)	Defines whether the prefix applies to IPv6 addresses.
final IpPrefixAggregation.Builder	keyed(Boolean value)	Defines whether buckets are returned as a hash rather than an array in the response.
final IpPrefixAggregation.Builder	minDocCount(Long value)	Minimum number of documents for buckets to be included in the response.
final IpPrefixAggregation.Builder	prefixLength(int value)	Required - Length of the network prefix.
protected IpPrefixAggregation.Builder	self()

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder

meta, meta, name

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

field

public final IpPrefixAggregation.Builder field(String value)

Required - The document IP address field to aggregation on. The field mapping type must be ip

API name: field

prefixLength

public final IpPrefixAggregation.Builder prefixLength(int value)

Required - Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. For IPv6 addresses the accepted range is [0, 128].

API name: prefix_length

isIpv6

public final IpPrefixAggregation.Builder isIpv6(@Nullable
 Boolean value)

Defines whether the prefix applies to IPv6 addresses.

API name: is_ipv6

appendPrefixLength

public final IpPrefixAggregation.Builder appendPrefixLength(@Nullable
 Boolean value)

Defines whether the prefix length is appended to IP address keys in the response.

API name: append_prefix_length

keyed

public final IpPrefixAggregation.Builder keyed(@Nullable
 Boolean value)

Defines whether buckets are returned as a hash rather than an array in the response.

API name: keyed

minDocCount

public final IpPrefixAggregation.Builder minDocCount(@Nullable
 Long value)

Minimum number of documents for buckets to be included in the response.

API name: min_doc_count

self

protected IpPrefixAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<IpPrefixAggregation.Builder>

build

public IpPrefixAggregation build()

Builds a IpPrefixAggregation.

Specified by:

build in interface ObjectBuilder<IpPrefixAggregation>

Throws:

NullPointerException - if some of the required fields are null.