Package org.opensearch.search.aggregations.bucket.composite

Interface CompositeAggregation

All Superinterfaces:

Aggregation, MultiBucketsAggregation, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

All Known Implementing Classes:

InternalComposite, ParsedComposite

public interface CompositeAggregation
extends MultiBucketsAggregation

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CompositeAggregation.Bucket

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Field Summary

Fields inherited from interface org.opensearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.Object>	afterKey()	Returns the last key in this aggregation.
static org.opensearch.common.xcontent.XContentBuilder	bucketToXContent(CompositeAggregation.Bucket bucket, org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
static void	buildCompositeMap(java.lang.String fieldName, java.util.Map<java.lang.String,java.lang.Object> composite, org.opensearch.common.xcontent.XContentBuilder builder)
java.util.List<? extends CompositeAggregation.Bucket>	getBuckets()
static org.opensearch.common.xcontent.XContentBuilder	toXContentFragment(CompositeAggregation aggregation, org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)

Methods inherited from interface org.opensearch.search.aggregations.Aggregation

getMetadata, getName, getType

Methods inherited from interface org.opensearch.common.xcontent.ToXContent

toXContent

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Method Details

getBuckets

java.util.List<? extends CompositeAggregation.Bucket> getBuckets()

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this aggregation.

afterKey

java.util.Map<java.lang.String,java.lang.Object> afterKey()

Returns the last key in this aggregation. It can be used to retrieve the buckets that are after these values. See CompositeAggregationBuilder.aggregateAfter(java.util.Map<java.lang.String, java.lang.Object>).

bucketToXContent

static org.opensearch.common.xcontent.XContentBuilder bucketToXContent(CompositeAggregation.Bucket bucket, org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Throws:

java.io.IOException

toXContentFragment

static org.opensearch.common.xcontent.XContentBuilder toXContentFragment(CompositeAggregation aggregation, org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Throws:

java.io.IOException

buildCompositeMap

static void buildCompositeMap(java.lang.String fieldName, java.util.Map<java.lang.String,java.lang.Object> composite, org.opensearch.common.xcontent.XContentBuilder builder) throws java.io.IOException

Throws:

java.io.IOException