ElasticAggregation
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
ElasticAggregation.type
Members list
Value members
Concrete methods
Constructs a type-safe instance of zio.elasticsearch.aggregation.AvgAggregation using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.aggregation.AvgAggregation using the specified parameters.
Type parameters
- A
-
expected number type
Value parameters
- field
-
the type-safe field for which avg aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.AvgAggregation that represents avg aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.AvgAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.AvgAggregation using the specified parameters.
Value parameters
- field
-
the field for which avg aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.AvgAggregation that represents avg aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.BucketSelectorAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.BucketSelectorAggregation using the specified parameters.
Value parameters
- bucketsPath
-
A map of script variables and their associated path to the buckets we wish to use for the variable
- name
-
aggregation name
- script
-
The script to run for this aggregation. The script can be inline, file or indexed
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.BucketSelectorAggregation that represents bucket selector aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.BucketSortAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.BucketSortAggregation using the specified parameters.
Value parameters
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.BucketSortAggregation that represents bucket sort aggregation to be performed.
Constructs a type-safe instance of zio.elasticsearch.aggregation.CardinalityAggregation using the specified parameters. It calculates an approximate count of distinct values.
Constructs a type-safe instance of zio.elasticsearch.aggregation.CardinalityAggregation using the specified parameters. It calculates an approximate count of distinct values.
Value parameters
- field
-
the type-safe field for which cardinality aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.CardinalityAggregation that represents cardinality aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.CardinalityAggregation using the specified parameters. It calculates an approximate count of distinct values.
Constructs an instance of zio.elasticsearch.aggregation.CardinalityAggregation using the specified parameters. It calculates an approximate count of distinct values.
Value parameters
- field
-
the field for which cardinality aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.CardinalityAggregation that represents cardinality aggregation to be performed.
Constructs a type-safe instance of zio.elasticsearch.aggregation.ExtendedStatsAggregation using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.aggregation.ExtendedStatsAggregation using the specified parameters.
Type parameters
- A
-
expected number type
Value parameters
- field
-
the type-safe field for which extended stats aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.ExtendedStatsAggregation that represents extended stats aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.ExtendedStatsAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.ExtendedStatsAggregation using the specified parameters.
Value parameters
- field
-
the field for which extended stats aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.ExtendedStatsAggregation that represents extended stats aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.FilterAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.FilterAggregation using the specified parameters.
Value parameters
- name
-
aggregation name
- query
-
a query which the documents must match
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.FilterAggregation that represents filter aggregation to be performed.
Constructs a type-safe instance of zio.elasticsearch.aggregation.MaxAggregation using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.aggregation.MaxAggregation using the specified parameters.
Type parameters
- A
-
expected number type
Value parameters
- field
-
the type-safe field for which max aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.MaxAggregation that represents max aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.MaxAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.MaxAggregation using the specified parameters.
Value parameters
- field
-
the field for which max aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.MaxAggregation that represents max aggregation to be performed.
Constructs a type-safe instance of zio.elasticsearch.aggregation.MinAggregation using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.aggregation.MinAggregation using the specified parameters.
Type parameters
- A
-
expected number type
Value parameters
- field
-
the type-safe field for which min aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.MinAggregation that represents min aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.MinAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.MinAggregation using the specified parameters.
Value parameters
- field
-
the field for which min aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.MinAggregation that represents min aggregation to be performed.
Constructs a type-safe instance of zio.elasticsearch.aggregation.MissingAggregation using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.aggregation.MissingAggregation using the specified parameters.
Value parameters
- field
-
the type-safe field for which missing aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.MissingAggregation that represents missing aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.MissingAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.MissingAggregation using the specified parameters.
Value parameters
- field
-
the field for which missing aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.MissingAggregation that represents missing aggregation to be performed.
Constructs an empty instance of the zio.elasticsearch.aggregation.MultipleAggregations.
Constructs an empty instance of the zio.elasticsearch.aggregation.MultipleAggregations.
Attributes
- Returns
-
an instance of empty zio.elasticsearch.aggregation.MultipleAggregations.
Constructs a type-safe instance of zio.elasticsearch.aggregation.PercentileRanksAggregation using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.aggregation.PercentileRanksAggregation using the specified parameters.
Type parameters
- A
-
expected number type
Value parameters
- field
-
the type-safe field for which percentile ranks aggregation will be executed
- name
-
the name of the aggregation
- value
-
the first value to be calculated for zio.elasticsearch.aggregation.PercentileRanksAggregation
- values
-
an array of values to be calculated for zio.elasticsearch.aggregation.PercentileRanksAggregation
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.PercentileRanksAggregation that represents percentile ranks aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.PercentileRanksAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.PercentileRanksAggregation using the specified parameters.
Value parameters
- field
-
the field for which percentile ranks aggregation will be executed
- name
-
the name of the aggregation
- value
-
the first value to be calculated for zio.elasticsearch.aggregation.PercentileRanksAggregation
- values
-
an array of values to be calculated for zio.elasticsearch.aggregation.PercentileRanksAggregation
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.PercentileRanksAggregation that represents percentile ranks aggregation to be performed.
Constructs a type-safe instance of zio.elasticsearch.aggregation.PercentilesAggregation using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.aggregation.PercentilesAggregation using the specified parameters.
Type parameters
- A
-
expected number type
Value parameters
- field
-
the type-safe field for which percentiles aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.PercentilesAggregation that represents percentiles aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.PercentilesAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.PercentilesAggregation using the specified parameters.
Value parameters
- field
-
the field for which percentiles aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.PercentilesAggregation that represents percentiles aggregation to be performed.
Constructs a type-safe instance of zio.elasticsearch.aggregation.StatsAggregation using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.aggregation.StatsAggregation using the specified parameters.
Type parameters
- A
-
expected number type
Value parameters
- field
-
the type-safe field for which stats aggregation will be executed
- name
-
the name of the aggregation
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.StatsAggregation that represents stats aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.StatsAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.StatsAggregation using the specified parameters.
Value parameters
- field
-
the field for which stats aggregation will be executed
- name
-
the name of the aggregation
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.StatsAggregation that represents stats aggregation to be performed.
Constructs a type-safe instance of zio.elasticsearch.aggregation.SumAggregation using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.aggregation.SumAggregation using the specified parameters.
Type parameters
- A
-
expected number type
Value parameters
- field
-
the type-safe field for which sum aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.SumAggregation that represents sum aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.SumAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.SumAggregation using the specified parameters.
Value parameters
- field
-
the field for which sum aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.SumAggregation that represents sum aggregation to be performed.
Constructs a type-safe instance of zio.elasticsearch.aggregation.TermsAggregation using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.aggregation.TermsAggregation using the specified parameters.
Value parameters
- field
-
the type-safe field for which the aggregation will be executed
- name
-
the name of the aggregation
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.TermsAggregation that represents terms aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.TermsAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.TermsAggregation using the specified parameters.
Value parameters
- field
-
the field for which terms aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.TermsAggregation that represents terms aggregation to be performed.
Constructs a type-safe instance of zio.elasticsearch.aggregation.ValueCountAggregation using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.aggregation.ValueCountAggregation using the specified parameters.
Value parameters
- field
-
the type-safe field for which value count aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.ValueCountAggregation that represents value count aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.ValueCountAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.ValueCountAggregation using the specified parameters.
Value parameters
- field
-
the field for which value count aggregation will be executed
- name
-
aggregation name
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.ValueCountAggregation that represents value count aggregation to be performed.
Constructs a type-safe instance of zio.elasticsearch.aggregation.WeightedAvgAggregation using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.aggregation.WeightedAvgAggregation using the specified parameters.
Value parameters
- name
-
aggregation name
- valueField
-
the type-safe field that represents value for which weighted avg aggregation will be executed
- weightField
-
the type-safe field that represents weight for which weighted avg aggregation will be executed
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.WeightedAvgAggregation that represents weighted avg aggregation to be performed.
Constructs an instance of zio.elasticsearch.aggregation.WeightedAvgAggregation using the specified parameters.
Constructs an instance of zio.elasticsearch.aggregation.WeightedAvgAggregation using the specified parameters.
Value parameters
- name
-
aggregation name
- valueField
-
the field that represents value for which weighted avg aggregation will be executed
- weightField
-
the field that represents weight for which weighted avg aggregation will be executed
Attributes
- Returns
-
an instance of zio.elasticsearch.aggregation.WeightedAvgAggregation that represents weighted avg aggregation to be performed.