Class IpPrefixAggregation
java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
co.elastic.clients.elasticsearch._types.aggregations.IpPrefixAggregation
- All Implemented Interfaces:
AggregationVariant
,JsonpSerializable
@JsonpDeserializable
public class IpPrefixAggregation
extends BucketAggregationBase
implements AggregationVariant
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<IpPrefixAggregation>
Json deserializer forIpPrefixAggregation
-
Method Summary
Modifier and TypeMethodDescriptionAggregation variant kind.final Boolean
Defines whether the prefix length is appended to IP address keys in the response.final String
field()
Required - The IP address field to aggregation on.final Boolean
isIpv6()
Defines whether the prefix applies to IPv6 addresses.final Boolean
keyed()
Defines whether buckets are returned as a hash rather than an array in the response.final Long
Minimum number of documents in a bucket for it to be included in the response.static IpPrefixAggregation
final int
Required - Length of the network prefix.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
setupBucketAggregationBaseDeserializer
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
meta, name, serialize, setupAggregationBaseDeserializer, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant
_toAggregation
-
Field Details
-
_DESERIALIZER
Json deserializer forIpPrefixAggregation
-
-
Method Details
-
of
public static IpPrefixAggregation of(Function<IpPrefixAggregation.Builder, ObjectBuilder<IpPrefixAggregation>> fn) -
_aggregationKind
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
field
Required - The IP address field to aggregation on. The field mapping type must beip
.API name:
field
-
prefixLength
public final int prefixLength()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
Defines whether the prefix applies to IPv6 addresses.API name:
is_ipv6
-
appendPrefixLength
Defines whether the prefix length is appended to IP address keys in the response.API name:
append_prefix_length
-
keyed
Defines whether buckets are returned as a hash rather than an array in the response.API name:
keyed
-
minDocCount
Minimum number of documents in a bucket for it to be included in the response.API name:
min_doc_count
-
serializeInternal
- Overrides:
serializeInternal
in classAggregationBase
-
setupIpPrefixAggregationDeserializer
protected static void setupIpPrefixAggregationDeserializer(ObjectDeserializer<IpPrefixAggregation.Builder> op)
-