Package org.opensearch.search.aggregations.pipeline

Class BucketScriptPipelineAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.PipelineAggregationBuilder

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

org.opensearch.search.aggregations.pipeline.BucketScriptPipelineAggregationBuilder

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 BucketScriptPipelineAggregationBuilder
extends AbstractPipelineAggregationBuilder<BucketScriptPipelineAggregationBuilder>

Aggregation Builder for bucket_script 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
static final org.opensearch.core.xcontent.ConstructingObjectParser<BucketScriptPipelineAggregationBuilder,String>	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.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
BucketScriptPipelineAggregationBuilder(String name, Map<String,String> bucketsPathsMap, Script script)
BucketScriptPipelineAggregationBuilder(String name, Script script, String... bucketsPaths)
BucketScriptPipelineAggregationBuilder(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()	Gets the format to use on the output of this aggregation.
BucketScriptPipelineAggregationBuilder	format(String format)	Sets the format to use on the output of this aggregation.
protected DocValueFormat	formatter()
BucketHelpers.GapPolicy	gapPolicy()	Gets the gap policy to use for this aggregation.
BucketScriptPipelineAggregationBuilder	gapPolicy(BucketHelpers.GapPolicy gapPolicy)	Sets the gap policy to use for this aggregation.
String	getWriteableName()
int	hashCode()
protected org.opensearch.core.xcontent.XContentBuilder	internalXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
protected boolean	overrideBucketsPath()
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, 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

PARSER

public static final org.opensearch.core.xcontent.ConstructingObjectParser<BucketScriptPipelineAggregationBuilder,String> PARSER

Constructor Details

BucketScriptPipelineAggregationBuilder

public BucketScriptPipelineAggregationBuilder(String name,
 Map<String,String> bucketsPathsMap,
 Script script)

BucketScriptPipelineAggregationBuilder

public BucketScriptPipelineAggregationBuilder(String name,
 Script script,
 String... bucketsPaths)

BucketScriptPipelineAggregationBuilder

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

Throws:

IOException

format

public BucketScriptPipelineAggregationBuilder format(String format)

Sets the format to use on the output of this aggregation.

format

public String format()

Gets the format to use on the output of this aggregation.

formatter

protected DocValueFormat formatter()

gapPolicy

public BucketScriptPipelineAggregationBuilder gapPolicy(BucketHelpers.GapPolicy gapPolicy)

Sets the gap policy to use for this aggregation.

gapPolicy

public BucketHelpers.GapPolicy gapPolicy()

Gets the gap policy to use for this aggregation.

createInternal

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

Specified by:

createInternal in class AbstractPipelineAggregationBuilder<BucketScriptPipelineAggregationBuilder>

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<BucketScriptPipelineAggregationBuilder>

Throws:

IOException

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

overrideBucketsPath

protected boolean overrideBucketsPath()

Overrides:

overrideBucketsPath in class AbstractPipelineAggregationBuilder<BucketScriptPipelineAggregationBuilder>

Returns:

true if the AbstractPipelineAggregationBuilder overrides the XContent rendering of the bucketPath option.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPipelineAggregationBuilder<BucketScriptPipelineAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractPipelineAggregationBuilder<BucketScriptPipelineAggregationBuilder>

getWriteableName

public String getWriteableName()