Class BucketSortPipelineAggregationBuilder
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
Modifier and TypeFieldDescriptionstatic
static org.elasticsearch.common.xcontent.ConstructingObjectParser<>
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
-
Method Summary
Modifier and TypeMethodDescriptionprotected PipelineAggregator
<,> metadata)
protected void
doWriteTo(StreamOutput out)
boolean
obj)
from(int from)
gapPolicy(BucketHelpers.GapPolicy gapPolicy)
Returns the name of the writeable objectint
hashCode()
protected org.elasticsearch.common.xcontent.XContentBuilder
internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
protected boolean
reducerName, org.elasticsearch.common.xcontent.XContentParser parser)
size)
protected void
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.
, , , , , , ,
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
Field Details
-
NAME
public static final NAME- See Also:
- Constant Field Values
-
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<> PARSER
-
-
Constructor Details
-
BucketSortPipelineAggregationBuilder
-
BucketSortPipelineAggregationBuilder
Read from a stream.- Throws:
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
- Throws:
-
from
-
size
public size) -
gapPolicy
-
createInternal
protected <,> metadata)- Specified by:
createInternal
in classAbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
-
validate
Description copied from class:PipelineAggregationBuilder
Makes sure this builder is properly configured.- Specified by:
validate
in classPipelineAggregationBuilder
-
internalXContent
protected org.elasticsearch.common.xcontent.XContentBuilder internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws- Specified by:
internalXContent
in classAbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
- Throws:
-
parse
public static reducerName, org.elasticsearch.common.xcontent.XContentParser parser) throws- Throws:
-
overrideBucketsPath
protected boolean overrideBucketsPath()- Overrides:
overrideBucketsPath
in classAbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
- Returns:
true
if theAbstractPipelineAggregationBuilder
overrides the XContent rendering of the bucketPath option.
-
hashCode
public int hashCode()- Overrides:
hashCode
in classAbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
-
equals
public boolean equals( obj)- Overrides:
equals
in classAbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
-
getWriteableName
public getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object
-