Package org.opensearch.search.profile.aggregation

Class AggregationProfileShardResult

java.lang.Object

org.opensearch.search.profile.aggregation.AggregationProfileShardResult

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public final class AggregationProfileShardResult
extends Object
implements Writeable, org.opensearch.common.xcontent.ToXContentFragment

A container class to hold the profile results for a single shard in the request. Contains a list of query profiles, a collector tree and a total rewrite tree.

Opensearch.internal:

Nested Class Summary

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

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AGGREGATIONS

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
AggregationProfileShardResult(List<ProfileResult> aggProfileResults)
AggregationProfileShardResult(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
static AggregationProfileShardResult	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
List<ProfileResult>	getProfileResults()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

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

isFragment

Field Details

AGGREGATIONS

public static final String AGGREGATIONS

See Also:

• Constant Field Values

Constructor Details

AggregationProfileShardResult

public AggregationProfileShardResult(List<ProfileResult> aggProfileResults)

AggregationProfileShardResult

public AggregationProfileShardResult(StreamInput in)
                              throws IOException

Read from a stream.

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getProfileResults

public List<ProfileResult> getProfileResults()

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                                                          throws IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

IOException

fromXContent

public static AggregationProfileShardResult fromXContent(org.opensearch.common.xcontent.XContentParser parser)
                                                  throws IOException

Throws:

IOException