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

Class StringStatsAggregate

java.lang.Object

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

org.opensearch.client.opensearch._types.aggregations.StringStatsAggregate

All Implemented Interfaces:

JsonpSerializable, AggregateVariant

@JsonpDeserializable
public class StringStatsAggregate
extends AggregateBase
implements AggregateVariant

Nested Class Summary

Nested Classes

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

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

AggregateBase.AbstractBuilder<BuilderT extends AggregateBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Aggregate.Kind	_aggregateKind()	Aggregate variant kind.
double	avgLength()	Required - API name: avg_length
java.lang.String	avgLengthAsString()	API name: avg_length_as_string
long	count()	Required - API name: count
java.lang.String	distribution()	API name: distribution
double	entropy()	Required - API name: entropy
int	maxLength()	Required - API name: max_length
java.lang.String	maxLengthAsString()	API name: max_length_as_string
int	minLength()	Required - API name: min_length
java.lang.String	minLengthAsString()	API name: min_length_as_string
static StringStatsAggregate	of(java.util.function.Function<StringStatsAggregate.Builder,ObjectBuilder<StringStatsAggregate>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupStringStatsAggregateDeserializer(ObjectDeserializer<StringStatsAggregate.Builder> op)

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

meta, serialize, setupAggregateBaseDeserializer

Methods inherited from class java.lang.Object

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

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

_toAggregate

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<StringStatsAggregate> _DESERIALIZER

Json deserializer for StringStatsAggregate

Method Detail

of

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

_aggregateKind

public Aggregate.Kind _aggregateKind()

Aggregate variant kind.

Specified by:

_aggregateKind in interface AggregateVariant

count

public final long count()

Required - API name: count

minLength

public final int minLength()

Required - API name: min_length

Defaults to 0 if parsed from a JSON null value.

maxLength

public final int maxLength()

Required - API name: max_length

Defaults to 0 if parsed from a JSON null value.

avgLength

public final double avgLength()

Required - API name: avg_length

Defaults to 0 if parsed from a JSON null value.

entropy

public final double entropy()

Required - API name: entropy

Defaults to 0 if parsed from a JSON null value.

distribution

@Nullable
public final java.lang.String distribution()

API name: distribution

minLengthAsString

@Nullable
public final java.lang.String minLengthAsString()

API name: min_length_as_string

maxLengthAsString

@Nullable
public final java.lang.String maxLengthAsString()

API name: max_length_as_string

avgLengthAsString

@Nullable
public final java.lang.String avgLengthAsString()

API name: avg_length_as_string

serializeInternal

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

Overrides:

serializeInternal in class AggregateBase

setupStringStatsAggregateDeserializer

protected static void setupStringStatsAggregateDeserializer(ObjectDeserializer<StringStatsAggregate.Builder> op)