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

Class RareTermsAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregationBase

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

org.opensearch.client.opensearch._types.aggregations.RareTermsAggregation

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, AggregationVariant, ToCopyableBuilder<RareTermsAggregation.Builder,RareTermsAggregation>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class RareTermsAggregation
extends BucketAggregationBase
implements AggregationVariant, ToCopyableBuilder<RareTermsAggregation.Builder,RareTermsAggregation>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RareTermsAggregation.Builder	Builder for RareTermsAggregation.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<RareTermsAggregation>	_DESERIALIZER	Json deserializer for RareTermsAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static RareTermsAggregation.Builder	builder()
boolean	equals(Object o)
final TermsExclude	exclude()	API name: exclude
final String	field()	API name: field
int	hashCode()
final TermsInclude	include()	API name: include
final Long	maxDocCount()	The maximum number of documents a term should appear in.
final FieldValue	missing()	API name: missing
static RareTermsAggregation	of(Function<RareTermsAggregation.Builder,ObjectBuilder<RareTermsAggregation>> fn)
final Double	precision()	The precision of the internal CuckooFilters.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRareTermsAggregationDeserializer(ObjectDeserializer<RareTermsAggregation.Builder> op)
RareTermsAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	valueType()	API name: value_type

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

setupBucketAggregationBaseDeserializer

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase

meta, name, serialize, setupAggregationBaseDeserializer

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant

toAggregation

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RareTermsAggregation> _DESERIALIZER

Json deserializer for RareTermsAggregation

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()

API name: exclude

field

@Nullable
public final String field()

API name: field

include

@Nullable
public final TermsInclude include()

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()

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

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

toBuilder

@Nonnull
public RareTermsAggregation.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RareTermsAggregation.Builder,RareTermsAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static RareTermsAggregation.Builder builder()

setupRareTermsAggregationDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase