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

Class RareTermsAggregation

java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
co.elastic.clients.elasticsearch._types.aggregations.RareTermsAggregation
All Implemented Interfaces:
AggregationVariant, JsonpSerializable
@JsonpDeserializable public class RareTermsAggregation extends BucketAggregationBase implements AggregationVariant, JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

      public static RareTermsAggregation of(Function<RareTermsAggregation.Builder,ObjectBuilder<RareTermsAggregation>> fn)

    • _aggregationKind

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

    • exclude

      @Nullable public final TermsExclude exclude()
      Terms that should be excluded from the aggregation.

      API name: exclude

    • field

      @Nullable public final String field()
      The field from which to return rare terms.

      API name: field

    • include

      @Nullable public final TermsInclude include()
      Terms that should be included in the aggregation.

      API name: include

    • maxDocCount

      @Nullable public final Long maxDocCount()
      The maximum number of documents a term should appear in.

      API name: max_doc_count

    • missing

      @Nullable public final FieldValue missing()
      The value to apply to documents that do not have a value. By default, documents without a value are ignored.

      API name: missing

    • precision

      @Nullable public final Double precision()
      The precision of the internal CuckooFilters. Smaller precision leads to better approximation, but higher memory usage.

      API name: precision

    • valueType

      @Nullable public final String valueType()
      API name: value_type

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupRareTermsAggregationDeserializer

      protected static void setupRareTermsAggregationDeserializer(ObjectDeserializer<RareTermsAggregation.Builder> op)