com
.
sksamuel
.
elastic4s
.
searches
aggs
package
aggs
Visibility
Public
All
Type Members
trait
AbstractAggregation
extends
AnyRef
trait
AggregationApi
extends
AnyRef
trait
AggregationDefinition
extends
AbstractAggregation
case class
AvgAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
pipelines:
Seq
[
PipelineAggregationDefinition
] =
Nil
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
CardinalityAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
missing:
Option
[
String
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
precisionThreshold:
Option
[
Long
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
ChildrenAggregationDefinition
(
name:
String
,
childType:
String
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
DateExtendedBounds
(
min:
ElasticDate
,
max:
ElasticDate
)
extends
ExtendedBounds
with
Product
with
Serializable
case class
DateHistogramAggregation
(
name:
String
,
interval:
Option
[
DateHistogramInterval
] =
None
,
minDocCount:
Option
[
Long
] =
None
,
timeZone:
Option
[
DateTimeZone
] =
None
,
order:
Option
[
HistogramOrder
] =
None
,
offset:
Option
[
String
] =
None
,
format:
Option
[
String
] =
None
,
field:
Option
[
String
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
missing:
Option
[
Any
] =
None
,
extendedBounds:
Option
[
ExtendedBounds
] =
None
,
pipelines:
Seq
[
PipelineAggregationDefinition
] =
Nil
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
DateRangeAggregation
(
name:
String
,
field:
Option
[
String
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
format:
Option
[
String
] =
None
,
timeZone:
Option
[
DateTimeZone
] =
None
,
keyed:
Option
[
Boolean
] =
None
,
ranges:
Seq
[(
Option
[
String
],
ElasticDate
,
ElasticDate
)] =
Nil
,
unboundedFrom:
Option
[(
Option
[
String
],
ElasticDate
)] =
None
,
unboundedTo:
Option
[(
Option
[
String
],
ElasticDate
)] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
DoubleExtendedBounds
(
min:
Double
,
max:
Double
)
extends
NumericExtendedBounds
with
Product
with
Serializable
sealed
trait
ExtendedBounds
extends
AnyRef
case class
ExtendedStatsAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
missing:
Option
[
Double
] =
None
,
sigma:
Option
[
Double
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
FilterAggregationDefinition
(
name:
String
,
query:
QueryDefinition
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
FiltersAggregationDefinition
(
name:
String
,
filters:
Iterable
[
QueryDefinition
]
,
pipelines:
Seq
[
PipelineAggregationDefinition
] =
Nil
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
GeoBoundsAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
format:
Option
[
String
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
wrapLongitude:
Option
[
Boolean
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
GeoCentroidAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
format:
Option
[
String
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
valueType:
Option
[
ValueType
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
GeoDistanceAggregationDefinition
(
name:
String
,
origin:
GeoPoint
,
field:
Option
[
String
] =
None
,
format:
Option
[
String
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
keyed:
Option
[
Boolean
] =
None
,
distanceType:
Option
[
GeoDistance
] =
None
,
unit:
Option
[
DistanceUnit
] =
None
,
ranges:
Seq
[(
Option
[
String
],
Double
,
Double
)] =
Nil
,
unboundedFrom:
Option
[(
Option
[
String
],
Double
)] =
None
,
unboundedTo:
Option
[(
Option
[
String
],
Double
)] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
GeoHashGridAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
shardSize:
Option
[
Int
] =
None
,
size:
Option
[
Int
] =
None
,
precision:
Option
[
Int
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
GlobalAggregationDefinition
(
name:
String
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
HistogramAggregation
(
name:
String
,
field:
Option
[
String
] =
None
,
format:
Option
[
String
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
minDocCount:
Option
[
Long
] =
None
,
interval:
Option
[
Double
] =
None
,
keyed:
Option
[
Boolean
] =
None
,
offset:
Option
[
Double
] =
None
,
extendedBounds:
Option
[
ExtendedBounds
] =
None
,
order:
Option
[
HistogramOrder
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
HistogramOrder
(
name:
String
,
asc:
Boolean
)
extends
Product
with
Serializable
case class
IpRangeAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
format:
Option
[
String
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
keyed:
Option
[
Boolean
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
ranges:
Seq
[(
Option
[
String
],
String
,
String
)] =
Nil
,
maskRanges:
Seq
[(
Option
[
String
],
String
)] =
Nil
,
unboundedFrom:
Option
[(
Option
[
String
],
String
)] =
None
,
unboundedTo:
Option
[(
Option
[
String
],
String
)] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
KeyedFiltersAggregationDefinition
(
name:
String
,
filters:
Iterable
[(
String
,
QueryDefinition
)]
,
otherBucket:
Option
[
Boolean
] =
None
,
otherBucketKey:
Option
[
String
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
LongExtendedBounds
(
min:
Long
,
max:
Long
)
extends
NumericExtendedBounds
with
Product
with
Serializable
case class
MaxAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
format:
Option
[
String
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
MinAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
format:
Option
[
String
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
MissingAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
NestedAggregationDefinition
(
name:
String
,
path:
String
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
sealed abstract
class
NumericExtendedBounds
extends
ExtendedBounds
case class
PercentileRanksAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
format:
Option
[
String
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
values:
Seq
[
Double
] =
Nil
,
method:
Option
[
PercentilesMethod
] =
None
,
keyed:
Option
[
Boolean
] =
None
,
numberOfSignificantValueDigits:
Option
[
Int
] =
None
,
compression:
Option
[
Double
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
PercentilesAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
format:
Option
[
String
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
numberOfSignificantValueDigits:
Option
[
Int
] =
None
,
percents:
Seq
[
Double
] =
Nil
,
compression:
Option
[
Double
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
sealed
trait
PercentilesMethod
extends
AnyRef
case class
RangeAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
format:
Option
[
String
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
keyed:
Option
[
Boolean
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
ranges:
Seq
[(
Option
[
String
],
Double
,
Double
)] =
Nil
,
unboundedFrom:
Option
[(
Option
[
String
],
Double
)] =
None
,
unboundedTo:
Option
[(
Option
[
String
],
Double
)] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
ReverseNestedAggregationDefinition
(
name:
String
,
path:
Option
[
String
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
SamplerAggregationDefinition
(
name:
String
,
shardSize:
Option
[
Int
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
ScriptedMetricAggregationDefinition
(
name:
String
,
initScript:
Option
[
ScriptDefinition
] =
None
,
mapScript:
Option
[
ScriptDefinition
] =
None
,
combineScript:
Option
[
ScriptDefinition
] =
None
,
reduceScript:
Option
[
ScriptDefinition
] =
None
,
params:
Map
[
String
,
AnyRef
] =
Map.empty
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
SigTermsAggregationDefinition
(
name:
String
,
minDocCount:
Option
[
Long
] =
None
,
executionHint:
Option
[
String
] =
None
,
size:
Option
[
Int
] =
None
,
includeExclude:
Option
[
IncludeExclude
] =
None
,
includePartition:
Option
[
IncludePartition
] =
None
,
field:
Option
[
String
] =
None
,
shardMinDocCount:
Option
[
Long
] =
None
,
shardSize:
Option
[
Int
] =
None
,
backgroundFilter:
Option
[
QueryDefinition
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
,
heuristic:
Option
[
String
] =
None
,
filterDuplicateText:
Option
[
Boolean
] =
None
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
SigTextAggregationDefinition
(
name:
String
,
minDocCount:
Option
[
Long
] =
None
,
executionHint:
Option
[
String
] =
None
,
size:
Option
[
Int
] =
None
,
includeExclude:
Option
[
IncludeExclude
] =
None
,
includePartition:
Option
[
IncludePartition
] =
None
,
field:
Option
[
String
] =
None
,
shardMinDocCount:
Option
[
Long
] =
None
,
shardSize:
Option
[
Int
] =
None
,
backgroundFilter:
Option
[
QueryDefinition
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
,
heuristic:
Option
[
String
] =
None
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
StatsAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
format:
Option
[
String
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
StringExtendedBounds
(
min:
String
,
max:
String
)
extends
ExtendedBounds
with
Product
with
Serializable
sealed
trait
SubAggCollectionMode
extends
AnyRef
case class
SumAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
TermsAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
missing:
Option
[
AnyRef
] =
None
,
size:
Option
[
Int
] =
None
,
minDocCount:
Option
[
Long
] =
None
,
showTermDocCountError:
Option
[
Boolean
] =
None
,
valueType:
Option
[
ValueType
] =
None
,
executionHint:
Option
[
String
] =
None
,
shardMinDocCount:
Option
[
Long
] =
None
,
collectMode:
Option
[
SubAggCollectionMode
] =
None
,
orders:
Seq
[
TermsOrder
] =
Nil
,
shardSize:
Option
[
Int
] =
None
,
includeExclude:
Option
[
IncludeExclude
] =
None
,
includePartition:
Option
[
IncludePartition
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
TermsOrder
(
name:
String
,
asc:
Boolean
=
true
)
extends
Product
with
Serializable
case class
TopHitsAggregationDefinition
(
name:
String
,
explain:
Option
[
Boolean
] =
None
,
fetchSource:
Option
[
FetchSourceContext
] =
None
,
size:
Option
[
Int
] =
None
,
sorts:
Seq
[
SortDefinition
] =
Nil
,
trackScores:
Option
[
Boolean
] =
None
,
version:
Option
[
Boolean
] =
None
,
scripts:
Map
[
String
,
ScriptDefinition
] =
Map.empty
,
storedFields:
Seq
[
String
] =
Nil
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
case class
ValueCountAggregationDefinition
(
name:
String
,
field:
Option
[
String
] =
None
,
script:
Option
[
ScriptDefinition
] =
None
,
subaggs:
Seq
[
AbstractAggregation
] =
Nil
,
metadata:
Map
[
String
,
AnyRef
] =
Map.empty
)
extends
AggregationDefinition
with
Product
with
Serializable
Value Members
object
ExtendedBounds
object
HistogramOrder
extends
Serializable
object
PercentilesMethod
object
SubAggCollectionMode
package
pipeline
Ungrouped