Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.pipeline

Class BucketSelectorPipelineAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.PipelineAggregationBuilder

org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<BucketSelectorPipelineAggregationBuilder>

org.elasticsearch.search.aggregations.pipeline.BucketSelectorPipelineAggregationBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, Rewriteable<PipelineAggregationBuilder>, BaseAggregationBuilder, ToXContent, ToXContentFragment

public class BucketSelectorPipelineAggregationBuilder
extends AbstractPipelineAggregationBuilder<BucketSelectorPipelineAggregationBuilder>

Nested Class Summary

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

PipelineAggregationBuilder.ValidationContext

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

BUCKETS_PATH_FIELD, metadata, type

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

bucketsPaths, name

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

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
BucketSelectorPipelineAggregationBuilder(String name, Map<String,String> bucketsPathsMap, Script script)
BucketSelectorPipelineAggregationBuilder(String name, Script script, String... bucketsPaths)
BucketSelectorPipelineAggregationBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected PipelineAggregator	createInternal(Map<String,Object> metadata)
protected void	doWriteTo(StreamOutput out)
boolean	equals(Object obj)
BucketHelpers.GapPolicy	gapPolicy()	Gets the gap policy to use for this aggregation.
BucketSelectorPipelineAggregationBuilder	gapPolicy(BucketHelpers.GapPolicy gapPolicy)	Sets the gap policy to use for this aggregation.
Version	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
protected boolean	overrideBucketsPath()
static BucketSelectorPipelineAggregationBuilder	parse(String reducerName, XContentParser parser)
protected void	validate(PipelineAggregationBuilder.ValidationContext context)	Makes sure this builder is properly configured.

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

create, getType, setMetadata, toXContent, type, writeTo

Methods inherited from class org.elasticsearch.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.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

BucketSelectorPipelineAggregationBuilder

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

BucketSelectorPipelineAggregationBuilder

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

BucketSelectorPipelineAggregationBuilder

public BucketSelectorPipelineAggregationBuilder(StreamInput in)
                                         throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractPipelineAggregationBuilder<BucketSelectorPipelineAggregationBuilder>

Throws:

IOException

gapPolicy

public BucketSelectorPipelineAggregationBuilder 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<BucketSelectorPipelineAggregationBuilder>

internalXContent

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

Specified by:

internalXContent in class AbstractPipelineAggregationBuilder<BucketSelectorPipelineAggregationBuilder>

Throws:

IOException

parse

public static BucketSelectorPipelineAggregationBuilder parse(String reducerName,
 XContentParser parser)
                                                      throws IOException

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

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPipelineAggregationBuilder<BucketSelectorPipelineAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractPipelineAggregationBuilder<BucketSelectorPipelineAggregationBuilder>

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

getMinimalSupportedVersion

public Version getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to