InternalOrder.CompoundOrder (server 6.8.13 API)

java.lang.Object
- org.elasticsearch.search.aggregations.BucketOrder
- - org.elasticsearch.search.aggregations.InternalOrder.CompoundOrder

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

InternalOrder
```
public static class InternalOrder.CompoundOrder
extends BucketOrder
```
MultiBucketsAggregation.Bucket ordering strategy to sort by multiple criteria.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
- Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
  Writeable.Reader<V>, Writeable.Writer<V>

Field Summary
- Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
  EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
`java.util.Comparator<MultiBucketsAggregation.Bucket>`	`comparator(Aggregator aggregator)`
`boolean`	`equals(java.lang.Object obj)`
`int`	`hashCode()`
`java.util.List<BucketOrder>`	`orderElements()`
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`

Methods inherited from class org.elasticsearch.search.aggregations.BucketOrder
aggregation, aggregation, compound, compound, count, key, toString, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment

- Method Detail
  - orderElements
```
public java.util.List<BucketOrder> orderElements()
```
    Returns:
    
    unmodifiable list of BucketOrders to sort on.
  - toXContent
```
public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - comparator
```
public java.util.Comparator<MultiBucketsAggregation.Bucket> comparator(Aggregator aggregator)
```
    Specified by:
    
    comparator in class BucketOrder
    
    Returns:
    
    A comparator for the bucket based on the given aggregator. The comparator is used in two phases:
    - aggregation phase, where each shard builds a list of buckets to be sent to the coordinating node. In this phase, the passed in aggregator will be the aggregator that aggregates the buckets on the shard level.
    - reduce phase, where the coordinating node gathers all the buckets from all the shards and reduces them to a final bucket list. In this case, the passed in aggregator will be null.
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class BucketOrder
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Specified by:
    
    equals in class BucketOrder