Package org.opensearch.search.aggregations.pipeline

Class DerivativePipelineAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.PipelineAggregationBuilder

org.opensearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<DerivativePipelineAggregationBuilder>

org.opensearch.search.aggregations.pipeline.DerivativePipelineAggregationBuilder

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, Rewriteable<PipelineAggregationBuilder>, BaseAggregationBuilder

public class DerivativePipelineAggregationBuilder
extends AbstractPipelineAggregationBuilder<DerivativePipelineAggregationBuilder>

Aggregation Builder for derivative agg

Opensearch.internal:

Nested Class Summary

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

PipelineAggregationBuilder.ValidationContext

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

Modifier and Type	Field	Description
static final String	NAME

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

BUCKETS_PATH_FIELD, metadata, type

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

bucketsPaths, name

Fields inherited from interface org.opensearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DerivativePipelineAggregationBuilder(String name, String bucketsPath)
DerivativePipelineAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected PipelineAggregator	createInternal(Map<String,Object> metadata)
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
boolean	equals(Object obj)
String	format()
DerivativePipelineAggregationBuilder	format(String format)
BucketHelpers.GapPolicy	gapPolicy()
DerivativePipelineAggregationBuilder	gapPolicy(BucketHelpers.GapPolicy gapPolicy)
String	getWriteableName()
int	hashCode()
protected org.opensearch.core.xcontent.XContentBuilder	internalXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
static DerivativePipelineAggregationBuilder	parse(String pipelineAggregatorName, org.opensearch.core.xcontent.XContentParser parser)
String	unit()
DerivativePipelineAggregationBuilder	unit(String units)
DerivativePipelineAggregationBuilder	unit(DateHistogramInterval units)
protected void	validate(PipelineAggregationBuilder.ValidationContext context)	Makes sure this builder is properly configured.

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

create, getType, overrideBucketsPath, setMetadata, toXContent, type, writeTo

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

getBucketsPaths, getName, rewrite, subAggregations, toString

Methods inherited from class java.lang.Object

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

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

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

DerivativePipelineAggregationBuilder

public DerivativePipelineAggregationBuilder(String name,
 String bucketsPath)

DerivativePipelineAggregationBuilder

public DerivativePipelineAggregationBuilder(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

Specified by:

doWriteTo in class AbstractPipelineAggregationBuilder<DerivativePipelineAggregationBuilder>

Throws:

IOException

format

public DerivativePipelineAggregationBuilder format(String format)

format

public String format()

gapPolicy

public DerivativePipelineAggregationBuilder gapPolicy(BucketHelpers.GapPolicy gapPolicy)

gapPolicy

public BucketHelpers.GapPolicy gapPolicy()

unit

public DerivativePipelineAggregationBuilder unit(String units)

unit

public DerivativePipelineAggregationBuilder unit(DateHistogramInterval units)

unit

public String unit()

createInternal

protected PipelineAggregator createInternal(Map<String,Object> metadata)

Specified by:

createInternal in class AbstractPipelineAggregationBuilder<DerivativePipelineAggregationBuilder>

validate

protected void validate(PipelineAggregationBuilder.ValidationContext context)

Description copied from class: PipelineAggregationBuilder

Makes sure this builder is properly configured.

Specified by:

validate in class PipelineAggregationBuilder

internalXContent

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

Specified by:

internalXContent in class AbstractPipelineAggregationBuilder<DerivativePipelineAggregationBuilder>

Throws:

IOException

parse

public static DerivativePipelineAggregationBuilder parse(String pipelineAggregatorName,
 org.opensearch.core.xcontent.XContentParser parser)
                                                  throws IOException

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractPipelineAggregationBuilder<DerivativePipelineAggregationBuilder>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPipelineAggregationBuilder<DerivativePipelineAggregationBuilder>

getWriteableName

public String getWriteableName()