Package org.opensearch.search.aggregations.pipeline

Class AvgBucketPipelineAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.PipelineAggregationBuilder

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

org.opensearch.search.aggregations.pipeline.BucketMetricsPipelineAggregationBuilder<AvgBucketPipelineAggregationBuilder>

org.opensearch.search.aggregations.pipeline.AvgBucketPipelineAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment, Rewriteable<PipelineAggregationBuilder>, BaseAggregationBuilder

public class AvgBucketPipelineAggregationBuilder
extends BucketMetricsPipelineAggregationBuilder<AvgBucketPipelineAggregationBuilder>

Aggregation Builder for avg_bucket 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.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	NAME
static final PipelineAggregator.Parser	PARSER

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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
AvgBucketPipelineAggregationBuilder(String name, String bucketsPath)
AvgBucketPipelineAggregationBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected PipelineAggregator	createInternal(Map<String,Object> metadata)
protected org.opensearch.common.xcontent.XContentBuilder	doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
String	getWriteableName()	Returns the name of the writeable object
protected void	innerWriteTo(StreamOutput out)

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

doWriteTo, equals, format, format, formatter, gapPolicy, gapPolicy, hashCode, internalXContent, validate

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.common.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

PARSER

public static final PipelineAggregator.Parser PARSER

Constructor Details

AvgBucketPipelineAggregationBuilder

public AvgBucketPipelineAggregationBuilder(String name,
 String bucketsPath)

AvgBucketPipelineAggregationBuilder

public AvgBucketPipelineAggregationBuilder(StreamInput in)
                                    throws IOException

Read from a stream.

Throws:

IOException

Method Details

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws IOException

Specified by:

innerWriteTo in class BucketMetricsPipelineAggregationBuilder<AvgBucketPipelineAggregationBuilder>

Throws:

IOException

createInternal

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

Specified by:

createInternal in class BucketMetricsPipelineAggregationBuilder<AvgBucketPipelineAggregationBuilder>

doXContentBody

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

Specified by:

doXContentBody in class BucketMetricsPipelineAggregationBuilder<AvgBucketPipelineAggregationBuilder>

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object