Uses of Class
org.elasticsearch.search.aggregations.BucketOrder

Packages that use BucketOrder

Package	Description
org.elasticsearch.search.aggregations
org.elasticsearch.search.aggregations.bucket.histogram
org.elasticsearch.search.aggregations.bucket.terms

Uses of BucketOrder in org.elasticsearch.search.aggregations

Subclasses of BucketOrder in org.elasticsearch.search.aggregations

Modifier and Type	Class	Description
class	InternalOrder	Implementations for MultiBucketsAggregation.Bucket ordering strategies.
static class	InternalOrder.Aggregation	MultiBucketsAggregation.Bucket ordering strategy to sort by a sub-aggregation.
static class	InternalOrder.CompoundOrder	MultiBucketsAggregation.Bucket ordering strategy to sort by multiple criteria.

Methods in org.elasticsearch.search.aggregations that return BucketOrder

Modifier and Type	Method	Description
static BucketOrder	BucketOrder.aggregation(String path, boolean asc)	Creates a bucket ordering strategy which sorts buckets based on a single-valued sub-aggregation.
static BucketOrder	BucketOrder.aggregation(String path, String metricName, boolean asc)	Creates a bucket ordering strategy which sorts buckets based on a metric from a multi-valued sub-aggregation.
static BucketOrder	BucketOrder.compound(List<BucketOrder> orders)	Creates a bucket ordering strategy which sorts buckets based on multiple criteria.
static BucketOrder	BucketOrder.compound(BucketOrder... orders)	Creates a bucket ordering strategy which sorts buckets based on multiple criteria.
static BucketOrder	BucketOrder.count(boolean asc)	Creates a bucket ordering strategy that sorts buckets by their document counts (ascending or descending).
static BucketOrder	BucketOrder.key(boolean asc)	Creates a bucket ordering strategy that sorts buckets by their keys (ascending or descending).
static BucketOrder	InternalOrder.Parser.parseOrderParam(XContentParser parser)	Parse a BucketOrder from XContent.
static BucketOrder	InternalOrder.Streams.readHistogramOrder(StreamInput in, boolean bwcOrderFlag)	ONLY FOR HISTOGRAM ORDER: Backwards compatibility logic to read a BucketOrder from a StreamInput.
static BucketOrder	InternalOrder.Streams.readOrder(StreamInput in)	Read a BucketOrder from a StreamInput.
static BucketOrder	InternalOrder.validate(BucketOrder order, Aggregator aggregator)	Validate a bucket ordering strategy for an Aggregator.

Methods in org.elasticsearch.search.aggregations that return types with arguments of type BucketOrder

Modifier and Type	Method	Description
List<BucketOrder>	InternalOrder.CompoundOrder.orderElements()

Methods in org.elasticsearch.search.aggregations with parameters of type BucketOrder

Modifier and Type	Method	Description
static BucketOrder	BucketOrder.compound(BucketOrder... orders)	Creates a bucket ordering strategy which sorts buckets based on multiple criteria.
static boolean	InternalOrder.isCountDesc(BucketOrder order)	Determine if the ordering strategy is sorting on bucket count descending.
static boolean	InternalOrder.isKeyAsc(BucketOrder order)	Determine if the ordering strategy is sorting on bucket key ascending.
static boolean	InternalOrder.isKeyDesc(BucketOrder order)	Determine if the ordering strategy is sorting on bucket key descending.
static boolean	InternalOrder.isKeyOrder(BucketOrder order)	Determine if the ordering strategy is sorting on bucket key (ascending or descending).
static BucketOrder	InternalOrder.validate(BucketOrder order, Aggregator aggregator)	Validate a bucket ordering strategy for an Aggregator.
static void	InternalOrder.Streams.writeHistogramOrder(BucketOrder order, StreamOutput out, boolean bwcOrderFlag)	ONLY FOR HISTOGRAM ORDER: Backwards compatibility logic to write a BucketOrder to a stream.
static void	InternalOrder.Streams.writeOrder(BucketOrder order, StreamOutput out)	Write a BucketOrder to a StreamOutput.

Method parameters in org.elasticsearch.search.aggregations with type arguments of type BucketOrder

Modifier and Type	Method	Description
static BucketOrder	BucketOrder.compound(List<BucketOrder> orders)	Creates a bucket ordering strategy which sorts buckets based on multiple criteria.

Uses of BucketOrder in org.elasticsearch.search.aggregations.bucket.histogram

Methods in org.elasticsearch.search.aggregations.bucket.histogram that return BucketOrder

Modifier and Type	Method	Description
BucketOrder	DateHistogramAggregationBuilder.order()	Return the order to use to sort buckets of this histogram.
BucketOrder	HistogramAggregationBuilder.order()	Return the order to use to sort buckets of this histogram.

Methods in org.elasticsearch.search.aggregations.bucket.histogram with parameters of type BucketOrder

Modifier and Type	Method	Description
DateHistogramAggregationBuilder	DateHistogramAggregationBuilder.order(BucketOrder order)	Set a new order on this builder and return the builder so that calls can be chained.
HistogramAggregationBuilder	HistogramAggregationBuilder.order(BucketOrder order)	Set a new order on this builder and return the builder so that calls can be chained.

Method parameters in org.elasticsearch.search.aggregations.bucket.histogram with type arguments of type BucketOrder

Modifier and Type	Method	Description
DateHistogramAggregationBuilder	DateHistogramAggregationBuilder.order(List<BucketOrder> orders)	Sets the order in which the buckets will be returned.
HistogramAggregationBuilder	HistogramAggregationBuilder.order(List<BucketOrder> orders)	Sets the order in which the buckets will be returned.

Constructors in org.elasticsearch.search.aggregations.bucket.histogram with parameters of type BucketOrder

Constructor	Description
DateHistogramAggregatorFactory(String name, ValuesSourceConfig<ValuesSource> config, long offset, BucketOrder order, boolean keyed, long minDocCount, Rounding rounding, Rounding shardRounding, ExtendedBounds extendedBounds, QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder, Map<String,Object> metaData)
HistogramAggregatorFactory(String name, ValuesSourceConfig<ValuesSource> config, double interval, double offset, BucketOrder order, boolean keyed, long minDocCount, double minBound, double maxBound, QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder, Map<String,Object> metaData)

Uses of BucketOrder in org.elasticsearch.search.aggregations.bucket.terms

Fields in org.elasticsearch.search.aggregations.bucket.terms declared as BucketOrder

Modifier and Type	Field	Description
protected BucketOrder	InternalRareTerms.order
protected BucketOrder	InternalTerms.order
protected BucketOrder	TermsAggregator.order

Methods in org.elasticsearch.search.aggregations.bucket.terms that return BucketOrder

Modifier and Type	Method	Description
BucketOrder	TermsAggregationBuilder.order()	Gets the order in which the buckets will be returned.

Methods in org.elasticsearch.search.aggregations.bucket.terms with parameters of type BucketOrder

Modifier and Type	Method	Description
TermsAggregationBuilder	TermsAggregationBuilder.order(BucketOrder order)	Set a new order on this builder and return the builder so that calls can be chained.

Method parameters in org.elasticsearch.search.aggregations.bucket.terms with type arguments of type BucketOrder

Modifier and Type	Method	Description
TermsAggregationBuilder	TermsAggregationBuilder.order(List<BucketOrder> orders)	Sets the order in which the buckets will be returned.

Constructors in org.elasticsearch.search.aggregations.bucket.terms with parameters of type BucketOrder

Constructor	Description
DoubleTerms(String name, BucketOrder order, int requiredSize, long minDocCount, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData, DocValueFormat format, int shardSize, boolean showTermDocCountError, long otherDocCount, List<org.elasticsearch.search.aggregations.bucket.terms.DoubleTerms.Bucket> buckets, long docCountError)
GlobalOrdinalsStringTermsAggregator(String name, AggregatorFactories factories, ValuesSource.Bytes.WithOrdinals valuesSource, BucketOrder order, DocValueFormat format, TermsAggregator.BucketCountThresholds bucketCountThresholds, IncludeExclude.OrdinalsFilter includeExclude, SearchContext context, Aggregator parent, boolean remapGlobalOrds, Aggregator.SubAggCollectionMode collectionMode, boolean showTermDocCountError, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)
InternalMappedTerms(String name, BucketOrder order, int requiredSize, long minDocCount, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData, DocValueFormat format, int shardSize, boolean showTermDocCountError, long otherDocCount, List<B> buckets, long docCountError)
InternalRareTerms(String name, BucketOrder order, long maxDocCount, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)
InternalTerms(String name, BucketOrder order, int requiredSize, long minDocCount, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)
LongTerms(String name, BucketOrder order, int requiredSize, long minDocCount, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData, DocValueFormat format, int shardSize, boolean showTermDocCountError, long otherDocCount, List<LongTerms.Bucket> buckets, long docCountError)
LongTermsAggregator(String name, AggregatorFactories factories, ValuesSource.Numeric valuesSource, DocValueFormat format, BucketOrder order, TermsAggregator.BucketCountThresholds bucketCountThresholds, SearchContext aggregationContext, Aggregator parent, Aggregator.SubAggCollectionMode subAggCollectMode, boolean showTermDocCountError, IncludeExclude.LongFilter longFilter, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)
StringTerms(String name, BucketOrder order, int requiredSize, long minDocCount, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData, DocValueFormat format, int shardSize, boolean showTermDocCountError, long otherDocCount, List<StringTerms.Bucket> buckets, long docCountError)
StringTermsAggregator(String name, AggregatorFactories factories, ValuesSource valuesSource, BucketOrder order, DocValueFormat format, TermsAggregator.BucketCountThresholds bucketCountThresholds, IncludeExclude.StringFilter includeExclude, SearchContext context, Aggregator parent, Aggregator.SubAggCollectionMode collectionMode, boolean showTermDocCountError, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)
TermsAggregator(String name, AggregatorFactories factories, SearchContext context, Aggregator parent, TermsAggregator.BucketCountThresholds bucketCountThresholds, BucketOrder order, DocValueFormat format, Aggregator.SubAggCollectionMode collectMode, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)
UnmappedTerms(String name, BucketOrder order, int requiredSize, long minDocCount, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)