org.elasticsearch.search.aggregations.pipeline.bucketscript

Class BucketScriptPipelineAggregatorBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.search.aggregations.pipeline.PipelineAggregatorBuilder<BucketScriptPipelineAggregatorBuilder>

org.elasticsearch.search.aggregations.pipeline.bucketscript.BucketScriptPipelineAggregatorBuilder

All Implemented Interfaces:

NamedWriteable<PipelineAggregatorBuilder<BucketScriptPipelineAggregatorBuilder>>, StreamableReader<PipelineAggregatorBuilder<BucketScriptPipelineAggregatorBuilder>>, Writeable<PipelineAggregatorBuilder<BucketScriptPipelineAggregatorBuilder>>, ToXContent

public class BucketScriptPipelineAggregatorBuilder
extends PipelineAggregatorBuilder<BucketScriptPipelineAggregatorBuilder>

Nested Class Summary

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

Writeable.Reader<R>

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.search.aggregations.pipeline.PipelineAggregatorBuilder

bucketsPaths, metaData, name, type

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
BucketScriptPipelineAggregatorBuilder(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> bucketsPathsMap, Script script)
BucketScriptPipelineAggregatorBuilder(java.lang.String name, Script script, java.lang.String... bucketsPaths)

Method Summary

Modifier and Type	Method and Description
protected PipelineAggregator	createInternal(java.util.Map<java.lang.String,java.lang.Object> metaData)
protected boolean	doEquals(java.lang.Object obj)
protected int	doHashCode()
protected BucketScriptPipelineAggregatorBuilder	doReadFrom(java.lang.String name, java.lang.String[] bucketsPaths, StreamInput in)
protected void	doWriteTo(StreamOutput out)
java.lang.String	format() Gets the format to use on the output of this aggregation.
BucketScriptPipelineAggregatorBuilder	format(java.lang.String format) Sets the format to use on the output of this aggregation.
protected ValueFormatter	formatter()
BucketHelpers.GapPolicy	gapPolicy() Gets the gap policy to use for this aggregation.
BucketScriptPipelineAggregatorBuilder	gapPolicy(BucketHelpers.GapPolicy gapPolicy) Sets the gap policy to use for this aggregation.
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
protected boolean	overrideBucketsPath()

Methods inherited from class org.elasticsearch.search.aggregations.pipeline.PipelineAggregatorBuilder

create, doValidate, equals, getBucketsPaths, getName, getWriteableName, hashCode, name, readFrom, setMetaData, toXContent, type, validate, writeTo

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BucketScriptPipelineAggregatorBuilder

public BucketScriptPipelineAggregatorBuilder(java.lang.String name,
                                             java.util.Map<java.lang.String,java.lang.String> bucketsPathsMap,
                                             Script script)

BucketScriptPipelineAggregatorBuilder

public BucketScriptPipelineAggregatorBuilder(java.lang.String name,
                                             Script script,
                                             java.lang.String... bucketsPaths)

Method Detail

format

public BucketScriptPipelineAggregatorBuilder format(java.lang.String 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

protected ValueFormatter formatter()

gapPolicy

public BucketScriptPipelineAggregatorBuilder 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(java.util.Map<java.lang.String,java.lang.Object> metaData)
                                     throws java.io.IOException

Specified by:

createInternal in class PipelineAggregatorBuilder<BucketScriptPipelineAggregatorBuilder>

Throws:

java.io.IOException

internalXContent

protected XContentBuilder internalXContent(XContentBuilder builder,
                                           ToXContent.Params params)
                                    throws java.io.IOException

Specified by:

internalXContent in class PipelineAggregatorBuilder<BucketScriptPipelineAggregatorBuilder>

Throws:

java.io.IOException

overrideBucketsPath

protected boolean overrideBucketsPath()

Overrides:

overrideBucketsPath in class PipelineAggregatorBuilder<BucketScriptPipelineAggregatorBuilder>

Returns:

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

doReadFrom

protected BucketScriptPipelineAggregatorBuilder doReadFrom(java.lang.String name,
                                                           java.lang.String[] bucketsPaths,
                                                           StreamInput in)
                                                    throws java.io.IOException

Specified by:

doReadFrom in class PipelineAggregatorBuilder<BucketScriptPipelineAggregatorBuilder>

Throws:

java.io.IOException

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class PipelineAggregatorBuilder<BucketScriptPipelineAggregatorBuilder>

Throws:

java.io.IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class PipelineAggregatorBuilder<BucketScriptPipelineAggregatorBuilder>

doEquals

protected boolean doEquals(java.lang.Object obj)

Specified by:

doEquals in class PipelineAggregatorBuilder<BucketScriptPipelineAggregatorBuilder>