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

Class CompositeAggregation

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

co.elastic.clients.elasticsearch._types.aggregations.CompositeAggregation

All Implemented Interfaces:

AggregationVariant, ApiKeyAggregationVariant, JsonpSerializable

@JsonpDeserializable
public class CompositeAggregation
extends BucketAggregationBase
implements AggregationVariant, ApiKeyAggregationVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._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.
ApiKeyAggregation.Kind	_apiKeyAggregationKind()	ApiKeyAggregation variant kind.
final Map<String,FieldValue>	after()	When paginating, use the after_key value returned in the previous response to retrieve the next page.
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.

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

setupBucketAggregationBaseDeserializer

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase

meta, name, serialize, setupAggregationBaseDeserializer, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant

_toAggregation

Methods inherited from interface co.elastic.clients.elasticsearch.security.query_api_keys.ApiKeyAggregationVariant

_toApiKeyAggregation

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

_apiKeyAggregationKind

public ApiKeyAggregation.Kind _apiKeyAggregationKind()

ApiKeyAggregation variant kind.

Specified by:

_apiKeyAggregationKind in interface ApiKeyAggregationVariant

after

public final Map<String,FieldValue> after()

When paginating, use the after_key value returned in the previous response to retrieve the next page.

API name: after

size

@Nullable
public final Integer size()

The number of composite buckets that should be returned.

API name: size

sources

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

setupCompositeAggregationDeserializer

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