Package org.opensearch.search.aggregations.pipeline

Class InternalDerivative

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation

org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation.SingleValue

org.opensearch.search.aggregations.pipeline.InternalSimpleValue

org.opensearch.search.aggregations.pipeline.InternalDerivative

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Aggregation, NumericMetricsAggregation, NumericMetricsAggregation.SingleValue, Derivative, SimpleValue

public class InternalDerivative
extends InternalSimpleValue
implements Derivative

Implementation of derivitive pipeline

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation

InternalNumericMetricsAggregation.MultiValue, InternalNumericMetricsAggregation.SingleValue

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.InternalAggregation

InternalAggregation.ReduceContext, InternalAggregation.ReduceContextBuilder

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

Aggregation.CommonFields

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

NumericMetricsAggregation.MultiValue, NumericMetricsAggregation.SingleValue

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

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.search.aggregations.pipeline.InternalSimpleValue

NAME, value

Fields inherited from class org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation

format

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

metadata, name

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
InternalDerivative(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
Object	getProperty(List<String> path)
String	getWriteableName()
int	hashCode()
double	normalizedValue()	Returns the normalized value.

Methods inherited from class org.opensearch.search.aggregations.pipeline.InternalSimpleValue

getValue, reduce, value

Methods inherited from class org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation.SingleValue

getValueAsString, sortValue

Methods inherited from class org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation

mustReduceOnSingleInternalAgg, sortValue

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

copyWithRewritenBuckets, forEachBucket, getMetadata, getName, getProperty, getType, isMapped, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, reducePipelines, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getMetadata, getName, getType

Methods inherited from interface org.opensearch.search.aggregations.metrics.NumericMetricsAggregation.SingleValue

getValueAsString, value

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

toXContent

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

isFragment

Constructor Details

InternalDerivative

public InternalDerivative(org.opensearch.core.common.io.stream.StreamInput in)
                   throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                  throws IOException

Overrides:

doWriteTo in class InternalSimpleValue

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable

Overrides:

getWriteableName in class InternalSimpleValue

normalizedValue

public double normalizedValue()

Description copied from interface: Derivative

Returns the normalized value. If no normalised factor has been specified this method will return NumericMetricsAggregation.SingleValue.value()

Specified by:

normalizedValue in interface Derivative

Returns:

the normalized value

getProperty

public Object getProperty(List<String> path)

Overrides:

getProperty in class InternalNumericMetricsAggregation.SingleValue

doXContentBody

public 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 InternalSimpleValue

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class InternalSimpleValue

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalSimpleValue