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
,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 java.lang.String
NAME
static org.elasticsearch.common.xcontent.ConstructingObjectParser<BucketSortPipelineAggregationBuilder,java.lang.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
-
Constructor Summary
Constructors Constructor Description BucketSortPipelineAggregationBuilder(java.lang.String name, java.util.List<FieldSortBuilder> sorts)
BucketSortPipelineAggregationBuilder(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)
BucketSortPipelineAggregationBuilder
from(int from)
BucketSortPipelineAggregationBuilder
gapPolicy(BucketHelpers.GapPolicy gapPolicy)
java.lang.String
getWriteableName()
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
overrideBucketsPath()
static BucketSortPipelineAggregationBuilder
parse(java.lang.String reducerName, org.elasticsearch.common.xcontent.XContentParser parser)
BucketSortPipelineAggregationBuilder
size(java.lang.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, subAggregations, toString
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<BucketSortPipelineAggregationBuilder,java.lang.String> PARSER
-
-
Constructor Details
-
BucketSortPipelineAggregationBuilder
public BucketSortPipelineAggregationBuilder(java.lang.String name, java.util.List<FieldSortBuilder> sorts) -
BucketSortPipelineAggregationBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
- Throws:
java.io.IOException
-
from
-
size
-
gapPolicy
-
createInternal
protected PipelineAggregator createInternal(java.util.Map<java.lang.String,java.lang.Object> 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 java.io.IOException- Specified by:
internalXContent
in classAbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
- Throws:
java.io.IOException
-
parse
public static BucketSortPipelineAggregationBuilder parse(java.lang.String reducerName, org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
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(java.lang.Object obj)- Overrides:
equals
in classAbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object
-