public class BucketSortPipelineAggregationBuilder extends AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
_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.Writeable.Reader<V>, Writeable.Writer<V>
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
static ConstructingObjectParser<BucketSortPipelineAggregationBuilder,java.lang.String> |
PARSER |
BUCKETS_PATH_FIELD, metaData, type
bucketsPaths, name
EMPTY_PARAMS
Constructor and Description |
---|
BucketSortPipelineAggregationBuilder(StreamInput in)
Read from a stream.
|
BucketSortPipelineAggregationBuilder(java.lang.String name,
java.util.List<FieldSortBuilder> sorts) |
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() |
void |
doValidate(AggregatorFactory<?> parent,
java.util.List<AggregationBuilder> aggFactories,
java.util.List<PipelineAggregationBuilder> pipelineAggregatoractories) |
protected void |
doWriteTo(StreamOutput out) |
BucketSortPipelineAggregationBuilder |
from(int from) |
BucketSortPipelineAggregationBuilder |
gapPolicy(BucketHelpers.GapPolicy gapPolicy) |
java.lang.String |
getWriteableName()
Returns the name of the writeable object
|
protected XContentBuilder |
internalXContent(XContentBuilder builder,
ToXContent.Params params) |
protected boolean |
overrideBucketsPath() |
static BucketSortPipelineAggregationBuilder |
parse(java.lang.String reducerName,
XContentParser parser) |
BucketSortPipelineAggregationBuilder |
size(java.lang.Integer size) |
create, equals, getType, hashCode, setMetaData, toXContent, type, validate, writeTo
getBucketsPaths, getName, subAggregations, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
isFragment
public static final java.lang.String NAME
public static final ConstructingObjectParser<BucketSortPipelineAggregationBuilder,java.lang.String> PARSER
public BucketSortPipelineAggregationBuilder(java.lang.String name, java.util.List<FieldSortBuilder> sorts)
public BucketSortPipelineAggregationBuilder(StreamInput in) throws java.io.IOException
java.io.IOException
protected void doWriteTo(StreamOutput out) throws java.io.IOException
doWriteTo
in class AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
java.io.IOException
public BucketSortPipelineAggregationBuilder from(int from)
public BucketSortPipelineAggregationBuilder size(java.lang.Integer size)
public BucketSortPipelineAggregationBuilder gapPolicy(BucketHelpers.GapPolicy gapPolicy)
protected PipelineAggregator createInternal(java.util.Map<java.lang.String,java.lang.Object> metaData) throws java.io.IOException
createInternal
in class AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
java.io.IOException
public void doValidate(AggregatorFactory<?> parent, java.util.List<AggregationBuilder> aggFactories, java.util.List<PipelineAggregationBuilder> pipelineAggregatoractories)
doValidate
in class AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
protected XContentBuilder internalXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
internalXContent
in class AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
java.io.IOException
public static BucketSortPipelineAggregationBuilder parse(java.lang.String reducerName, XContentParser parser) throws java.io.IOException
java.io.IOException
protected boolean overrideBucketsPath()
overrideBucketsPath
in class AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
true
if the AbstractPipelineAggregationBuilder
overrides the XContent rendering of the bucketPath option.protected int doHashCode()
doHashCode
in class AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
protected boolean doEquals(java.lang.Object obj)
doEquals
in class AbstractPipelineAggregationBuilder<BucketSortPipelineAggregationBuilder>
public java.lang.String getWriteableName()
NamedWriteable