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

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:
API specification

  • Field Details

  • Method Details

    • of

      public static IpPrefixAggregation of​(java.util.function.Function<IpPrefixAggregation.Builder,​ObjectBuilder<IpPrefixAggregation>> fn)

    • _aggregationKind

      public Aggregation.Kind _aggregationKind()
      Aggregation variant kind.
      Specified by:
      _aggregationKind in interface AggregationVariant

    • field

      public final java.lang.String field()
      Required - The document IP address field to aggregation on. The field mapping type must be ip

      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

      @Nullable public final java.lang.Boolean isIpv6()
      Defines whether the prefix applies to IPv6 addresses.

      API name: is_ipv6

    • appendPrefixLength

      @Nullable public final java.lang.Boolean appendPrefixLength()
      Defines whether the prefix length is appended to IP address keys in the response.

      API name: append_prefix_length

    • keyed

      @Nullable public final java.lang.Boolean keyed()
      Defines whether buckets are returned as a hash rather than an array in the response.

      API name: keyed

    • minDocCount

      @Nullable public final java.lang.Long minDocCount()
      Minimum number of documents for buckets to be included in the response.

      API name: min_doc_count

    • serializeInternal

      protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class AggregationBase

    • setupIpPrefixAggregationDeserializer

      protected static void setupIpPrefixAggregationDeserializer​(ObjectDeserializer<IpPrefixAggregation.Builder> op)