Package org.elasticsearch.search.aggregations.pipeline

Class BucketSortPipelineAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.PipelineAggregationBuilder

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

org.elasticsearch.search.aggregations.pipeline.BucketSortPipelineAggregationBuilder

All Implemented Interfaces:

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

public class BucketSortPipelineAggregationBuilder
extends AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>

Builds a pipeline aggregation that allows sorting the buckets of its parent aggregation. The bucket _key, _count or sub-aggregations may be used as sort keys. Parameters from and size may also be set in order to truncate the result bucket list.

Nested Class Summary

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

PipelineAggregationBuilder.ValidationContext

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 String	NAME
static org.elasticsearch.common.xcontent.ConstructingObjectParser<BucketSortPipelineAggregationBuilder,String>	PARSER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
BucketSortPipelineAggregationBuilder(String name, List<FieldSortBuilder> sorts)
BucketSortPipelineAggregationBuilder(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)
BucketSortPipelineAggregationBuilder	from(int from)
BucketSortPipelineAggregationBuilder	gapPolicy(BucketHelpers.GapPolicy gapPolicy)
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
protected org.elasticsearch.common.xcontent.XContentBuilder	internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
protected boolean	overrideBucketsPath()
static BucketSortPipelineAggregationBuilder	parse(String reducerName, org.elasticsearch.common.xcontent.XContentParser parser)
BucketSortPipelineAggregationBuilder	size(Integer size)
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.common.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

Constant Field Values

PARSER

public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<BucketSortPipelineAggregationBuilder,String> PARSER

Constructor Details

BucketSortPipelineAggregationBuilder

public BucketSortPipelineAggregationBuilder(String name,
 List<FieldSortBuilder> sorts)

BucketSortPipelineAggregationBuilder

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

Throws:

IOException

from

public BucketSortPipelineAggregationBuilder from(int from)

size

public BucketSortPipelineAggregationBuilder size(Integer size)

gapPolicy

public BucketSortPipelineAggregationBuilder gapPolicy(BucketHelpers.GapPolicy gapPolicy)

createInternal

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

Specified by:

createInternal in class AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>

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

internalXContent

protected org.elasticsearch.common.xcontent.XContentBuilder internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                                      throws IOException

Specified by:

internalXContent in class AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>

Throws:

IOException

parse

public static BucketSortPipelineAggregationBuilder parse(String reducerName,
 org.elasticsearch.common.xcontent.XContentParser parser)
                                                  throws IOException

Throws:

IOException

overrideBucketsPath

protected boolean overrideBucketsPath()

Overrides:

overrideBucketsPath in class AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object