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:
NamedWriteable
,Writeable
,org.opensearch.common.xcontent.ToXContent
,org.opensearch.common.xcontent.ToXContentFragment
,Rewriteable<PipelineAggregationBuilder>
,BaseAggregationBuilder
public class BucketScriptPipelineAggregationBuilder extends AbstractPipelineAggregationBuilder<BucketScriptPipelineAggregationBuilder>
-
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 java.lang.String
NAME
static org.opensearch.common.xcontent.ConstructingObjectParser<BucketScriptPipelineAggregationBuilder,java.lang.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
-
Constructor Summary
Constructors Constructor Description BucketScriptPipelineAggregationBuilder(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> bucketsPathsMap, Script script)
BucketScriptPipelineAggregationBuilder(java.lang.String name, Script script, java.lang.String... bucketsPaths)
BucketScriptPipelineAggregationBuilder(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description protected PipelineAggregator
createInternal(java.util.Map<java.lang.String,java.lang.Object> metadata)
protected void
doWriteTo(StreamOutput out)
boolean
equals(java.lang.Object obj)
java.lang.String
format()
Gets the format to use on the output of this aggregation.BucketScriptPipelineAggregationBuilder
format(java.lang.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.java.lang.String
getWriteableName()
Returns the name of the writeable objectint
hashCode()
protected org.opensearch.common.xcontent.XContentBuilder
internalXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.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
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
PARSER
public static final org.opensearch.common.xcontent.ConstructingObjectParser<BucketScriptPipelineAggregationBuilder,java.lang.String> PARSER
-
-
Constructor Details
-
BucketScriptPipelineAggregationBuilder
public BucketScriptPipelineAggregationBuilder(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> bucketsPathsMap, Script script) -
BucketScriptPipelineAggregationBuilder
public BucketScriptPipelineAggregationBuilder(java.lang.String name, Script script, java.lang.String... bucketsPaths) -
BucketScriptPipelineAggregationBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractPipelineAggregationBuilder<BucketScriptPipelineAggregationBuilder>
- Throws:
java.io.IOException
-
format
Sets the format to use on the output of this aggregation. -
format
public java.lang.String format()Gets the format to use on the output of this aggregation. -
formatter
-
gapPolicy
Sets the gap policy to use for this aggregation. -
gapPolicy
Gets the gap policy to use for this aggregation. -
createInternal
protected PipelineAggregator createInternal(java.util.Map<java.lang.String,java.lang.Object> metadata)- Specified by:
createInternal
in classAbstractPipelineAggregationBuilder<BucketScriptPipelineAggregationBuilder>
-
internalXContent
protected org.opensearch.common.xcontent.XContentBuilder internalXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
internalXContent
in classAbstractPipelineAggregationBuilder<BucketScriptPipelineAggregationBuilder>
- Throws:
java.io.IOException
-
validate
Description copied from class:PipelineAggregationBuilder
Makes sure this builder is properly configured.- Specified by:
validate
in classPipelineAggregationBuilder
-
overrideBucketsPath
protected boolean overrideBucketsPath()- Overrides:
overrideBucketsPath
in classAbstractPipelineAggregationBuilder<BucketScriptPipelineAggregationBuilder>
- Returns:
true
if theAbstractPipelineAggregationBuilder
overrides the XContent rendering of the bucketPath option.
-
hashCode
public int hashCode()- Overrides:
hashCode
in classAbstractPipelineAggregationBuilder<BucketScriptPipelineAggregationBuilder>
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classAbstractPipelineAggregationBuilder<BucketScriptPipelineAggregationBuilder>
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object
-