Package org.opensearch.search.aggregations.metrics

Class ParsedScriptedMetric

java.lang.Object

org.opensearch.search.aggregations.ParsedAggregation

org.opensearch.search.aggregations.metrics.ParsedScriptedMetric

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Aggregation, ScriptedMetric

public class ParsedScriptedMetric
extends ParsedAggregation
implements ScriptedMetric

A scripted metric result parsed between nodes

Opensearch.internal:

Nested Class Summary

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

Aggregation.CommonFields

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

Method Summary

Modifier and Type	Method	Description
Object	aggregation()	The result of the aggregation.
org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
static ParsedScriptedMetric	fromXContent(org.opensearch.core.xcontent.XContentParser parser, String name)
String	getType()

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

ParsedScriptedMetric

public ParsedScriptedMetric()

Method Details

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.

aggregation

public Object aggregation()

Description copied from interface: ScriptedMetric

The result of the aggregation. The type of the object depends on the aggregation that was run.

Specified by:

aggregation in interface ScriptedMetric

doXContentBody

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

Specified by:

doXContentBody in class ParsedAggregation

Throws:

IOException

fromXContent

public static ParsedScriptedMetric fromXContent(org.opensearch.core.xcontent.XContentParser parser,
 String name)