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

Class StringTermsAggregate

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregateBase

org.opensearch.client.opensearch._types.aggregations.MultiBucketAggregateBase<StringTermsBucket>

org.opensearch.client.opensearch._types.aggregations.TermsAggregateBase<StringTermsBucket>

org.opensearch.client.opensearch._types.aggregations.StringTermsAggregate

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, AggregateVariant, ToCopyableBuilder<StringTermsAggregate.Builder,StringTermsAggregate>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class StringTermsAggregate
extends TermsAggregateBase<StringTermsBucket>
implements AggregateVariant, ToCopyableBuilder<StringTermsAggregate.Builder,StringTermsAggregate>

Result of a terms aggregation when the field is a string.

Nested Class Summary

Nested Classes

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

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

TermsAggregateBase.AbstractBuilder<TBucket,BuilderT extends TermsAggregateBase.AbstractBuilder<TBucket,BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Aggregate.Kind	_aggregateKind()	Aggregate variant kind.
static StringTermsAggregate.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static StringTermsAggregate	of(Function<StringTermsAggregate.Builder,ObjectBuilder<StringTermsAggregate>> fn)
protected static void	setupStringTermsAggregateDeserializer(ObjectDeserializer<StringTermsAggregate.Builder> op)
StringTermsAggregate.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

docCountErrorUpperBound, serializeInternal, setupTermsAggregateBaseDeserializer, sumOtherDocCount

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

buckets, setupMultiBucketAggregateBaseDeserializer

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

meta, serialize, setupAggregateBaseDeserializer

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.AggregateVariant

toAggregate

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<StringTermsAggregate> _DESERIALIZER

Json deserializer for StringTermsAggregate

Method Details

of

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

_aggregateKind

public Aggregate.Kind _aggregateKind()

Aggregate variant kind.

Specified by:

_aggregateKind in interface AggregateVariant

toBuilder

@Nonnull
public StringTermsAggregate.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<StringTermsAggregate.Builder,StringTermsAggregate>

Returns:

a new builder instance.

builder

@Nonnull
public static StringTermsAggregate.Builder builder()

setupStringTermsAggregateDeserializer

protected static void setupStringTermsAggregateDeserializer(ObjectDeserializer<StringTermsAggregate.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class TermsAggregateBase<StringTermsBucket>

equals

public boolean equals(Object o)

Overrides:

equals in class TermsAggregateBase<StringTermsBucket>