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

Class CompositeAggregation

java.lang.Object

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

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

org.opensearch.client.opensearch._types.aggregations.CompositeAggregation

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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<CompositeAggregation>	_DESERIALIZER	Json deserializer for CompositeAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
final Map<String,FieldValue>	after()	API name: after
static CompositeAggregation.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static CompositeAggregation	of(Function<CompositeAggregation.Builder,ObjectBuilder<CompositeAggregation>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupCompositeAggregationDeserializer(ObjectDeserializer<CompositeAggregation.Builder> op)
final Integer	size()	The number of composite buckets that should be returned.
final List<Map<String,CompositeAggregationSource>>	sources()	The value sources used to build composite buckets.
CompositeAggregation.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.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<CompositeAggregation> _DESERIALIZER

Json deserializer for CompositeAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

after

@Nonnull
public final Map<String,FieldValue> after()

API name: after

size

@Nullable
public final Integer size()

The number of composite buckets that should be returned.

API name: size

sources

@Nonnull
public final List<Map<String,CompositeAggregationSource>> sources()

The value sources used to build composite buckets. Keys are returned in the order of the sources definition.

API name: sources

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static CompositeAggregation.Builder builder()

setupCompositeAggregationDeserializer

protected static void setupCompositeAggregationDeserializer(ObjectDeserializer<CompositeAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase