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

Class ParsedComposite

java.lang.Object

org.opensearch.search.aggregations.ParsedAggregation

org.opensearch.search.aggregations.ParsedMultiBucketAggregation<ParsedComposite.ParsedBucket>

org.opensearch.search.aggregations.bucket.composite.ParsedComposite

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Aggregation, CompositeAggregation, MultiBucketsAggregation

public class ParsedComposite
extends ParsedMultiBucketAggregation<ParsedComposite.ParsedBucket>
implements CompositeAggregation

A composite result parsed between nodes

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParsedComposite.ParsedBucket	Parsed bucket for the parsed composite agg

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

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.bucket.composite.CompositeAggregation

CompositeAggregation.Bucket

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

MultiBucketsAggregation.Bucket

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

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

Field Summary

Fields inherited from class org.opensearch.search.aggregations.ParsedMultiBucketAggregation

buckets, keyed

Fields inherited from class org.opensearch.search.aggregations.ParsedAggregation

metadata

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

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsedComposite()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	afterKey()	Returns the last key in this aggregation.
protected org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
static ParsedComposite	fromXContent(org.opensearch.core.xcontent.XContentParser parser, String name)
List<ParsedComposite.ParsedBucket>	getBuckets()
String	getType()

Methods inherited from class org.opensearch.search.aggregations.ParsedMultiBucketAggregation

declareMultiBucketAggregationFields

Methods inherited from class org.opensearch.search.aggregations.ParsedAggregation

declareAggregationFields, getMetadata, getName, parseDouble, setName, toXContent

Methods inherited from class java.lang.Object

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

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

getMetadata, getName

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

toXContent

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

isFragment

Constructor Details

ParsedComposite

public ParsedComposite()

Method Details

fromXContent

public static ParsedComposite fromXContent(org.opensearch.core.xcontent.XContentParser parser,
 String name)
                                    throws IOException

Throws:

IOException

getType

public String getType()

Specified by:

getType in interface Aggregation

Returns:

a string representing the type of the aggregation. This type is added to the aggregation name in the response, so that it can later be used by clients to determine type of the aggregation and parse it into the proper object.

getBuckets

public List<ParsedComposite.ParsedBucket> getBuckets()

Specified by:

getBuckets in interface CompositeAggregation

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this aggregation.

afterKey

public Map<String,Object> afterKey()

Description copied from interface: CompositeAggregation

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

Specified by:

afterKey in interface CompositeAggregation

doXContentBody

protected org.opensearch.core.xcontent.XContentBuilder doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                               throws IOException

Overrides:

doXContentBody in class ParsedMultiBucketAggregation<ParsedComposite.ParsedBucket>

Throws:

IOException