Class Aggregation
java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.Aggregation
- All Implemented Interfaces:
JsonpSerializable
,OpenTaggedUnion<Aggregation.Kind,
,Object> TaggedUnion<Aggregation.Kind,
Object>
@JsonpDeserializable
public class Aggregation
extends Object
implements OpenTaggedUnion<Aggregation.Kind,Object>, JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescription_custom()
Get the custom plugin-defined variant value.final String
Get the actual kind when_kind()
equalsAggregation.Kind._Custom
(plugin-defined variant).final Object
_get()
boolean
Is this a customAggregation
defined by a plugin?final Aggregation.Kind
_kind()
Get the of the kind of variant held by this object.Get theadjacency_matrix
variant value.final Map<String,
Aggregation> Sub-aggregations for this aggregation.Get theauto_date_histogram
variant value.avg()
Get theavg
variant value.Get theavg_bucket
variant value.boxplot()
Get theboxplot
variant value.Get thebucket_script
variant value.Get thebucket_selector
variant value.Get thebucket_sort
variant value.Get thecardinality
variant value.children()
Get thechildren
variant value.Get thecomposite
variant value.Get thecumulative_cardinality
variant value.Get thecumulative_sum
variant value.Get thedate_histogram
variant value.Get thedate_range
variant value.Get thederivative
variant value.Get thediversified_sampler
variant value.Get theextended_stats
variant value.Get theextended_stats_bucket
variant value.filter()
Get thefilter
variant value.filters()
Get thefilters
variant value.Get thegeo_bounds
variant value.Get thegeo_centroid
variant value.Get thegeo_distance
variant value.Get thegeohash_grid
variant value.geoLine()
Get thegeo_line
variant value.Get thegeotile_grid
variant value.global()
Get theglobal
variant value.Get thehistogram
variant value.Get theinference
variant value.ipRange()
Get theip_range
variant value.boolean
Is this variant instance of kindadjacency_matrix
?boolean
Is this variant instance of kindauto_date_histogram
?boolean
isAvg()
Is this variant instance of kindavg
?boolean
Is this variant instance of kindavg_bucket
?boolean
Is this variant instance of kindboxplot
?boolean
Is this variant instance of kindbucket_script
?boolean
Is this variant instance of kindbucket_selector
?boolean
Is this variant instance of kindbucket_sort
?boolean
Is this variant instance of kindcardinality
?boolean
Is this variant instance of kindchildren
?boolean
Is this variant instance of kindcomposite
?boolean
Is this variant instance of kindcumulative_cardinality
?boolean
Is this variant instance of kindcumulative_sum
?boolean
Is this variant instance of kinddate_histogram
?boolean
Is this variant instance of kinddate_range
?boolean
Is this variant instance of kindderivative
?boolean
Is this variant instance of kinddiversified_sampler
?boolean
Is this variant instance of kindextended_stats
?boolean
Is this variant instance of kindextended_stats_bucket
?boolean
isFilter()
Is this variant instance of kindfilter
?boolean
Is this variant instance of kindfilters
?boolean
Is this variant instance of kindgeo_bounds
?boolean
Is this variant instance of kindgeo_centroid
?boolean
Is this variant instance of kindgeo_distance
?boolean
Is this variant instance of kindgeohash_grid
?boolean
Is this variant instance of kindgeo_line
?boolean
Is this variant instance of kindgeotile_grid
?boolean
isGlobal()
Is this variant instance of kindglobal
?boolean
Is this variant instance of kindhistogram
?boolean
Is this variant instance of kindinference
?boolean
Is this variant instance of kindip_range
?boolean
Is this variant instance of kindmatrix_stats
?boolean
isMax()
Is this variant instance of kindmax
?boolean
Is this variant instance of kindmax_bucket
?boolean
Is this variant instance of kindmedian_absolute_deviation
?boolean
isMin()
Is this variant instance of kindmin
?boolean
Is this variant instance of kindmin_bucket
?boolean
Is this variant instance of kindmissing
?boolean
Is this variant instance of kindmoving_avg
?boolean
Is this variant instance of kindmoving_fn
?boolean
Is this variant instance of kindmoving_percentiles
?boolean
Is this variant instance of kindmulti_terms
?boolean
isNested()
Is this variant instance of kindnested
?boolean
Is this variant instance of kindnormalize
?boolean
isParent()
Is this variant instance of kindparent
?boolean
Is this variant instance of kindpercentile_ranks
?boolean
Is this variant instance of kindpercentiles
?boolean
Is this variant instance of kindpercentiles_bucket
?boolean
isRange()
Is this variant instance of kindrange
?boolean
Is this variant instance of kindrare_terms
?boolean
isRate()
Is this variant instance of kindrate
?boolean
Is this variant instance of kindreverse_nested
?boolean
Is this variant instance of kindsampler
?boolean
Is this variant instance of kindscripted_metric
?boolean
Is this variant instance of kindserial_diff
?boolean
Is this variant instance of kindsignificant_terms
?boolean
Is this variant instance of kindsignificant_text
?boolean
isStats()
Is this variant instance of kindstats
?boolean
Is this variant instance of kindstats_bucket
?boolean
Is this variant instance of kindstring_stats
?boolean
isSum()
Is this variant instance of kindsum
?boolean
Is this variant instance of kindsum_bucket
?boolean
isTerms()
Is this variant instance of kindterms
?boolean
Is this variant instance of kindtop_hits
?boolean
Is this variant instance of kindtop_metrics
?boolean
isTTest()
Is this variant instance of kindt_test
?boolean
Is this variant instance of kindvalue_count
?boolean
Is this variant instance of kindvariable_width_histogram
?boolean
Is this variant instance of kindweighted_avg
?Get thematrix_stats
variant value.max()
Get themax
variant value.Get themax_bucket
variant value.Get themedian_absolute_deviation
variant value.meta()
API name:meta
min()
Get themin
variant value.Get themin_bucket
variant value.missing()
Get themissing
variant value.Get themoving_avg
variant value.movingFn()
Get themoving_fn
variant value.Get themoving_percentiles
variant value.Get themulti_terms
variant value.nested()
Get thenested
variant value.Get thenormalize
variant value.static Aggregation
parent()
Get theparent
variant value.Get thepercentile_ranks
variant value.Get thepercentiles
variant value.Get thepercentiles_bucket
variant value.range()
Get therange
variant value.Get therare_terms
variant value.rate()
Get therate
variant value.Get thereverse_nested
variant value.sampler()
Get thesampler
variant value.Get thescripted_metric
variant value.Get theserial_diff
variant value.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
Get thesignificant_terms
variant value.Get thesignificant_text
variant value.stats()
Get thestats
variant value.Get thestats_bucket
variant value.Get thestring_stats
variant value.sum()
Get thesum
variant value.Get thesum_bucket
variant value.terms()
Get theterms
variant value.topHits()
Get thetop_hits
variant value.Get thetop_metrics
variant value.toString()
tTest()
Get thet_test
variant value.Get thevalue_count
variant value.Get thevariable_width_histogram
variant value.Get theweighted_avg
variant value.
-
Field Details
-
_DESERIALIZER
-
-
Constructor Details
-
Aggregation
-
-
Method Details
-
_kind
Description copied from interface:TaggedUnion
Get the of the kind of variant held by this object.- Specified by:
_kind
in interfaceTaggedUnion<Aggregation.Kind,
Object> - Returns:
- the variant kind
-
_get
- Specified by:
_get
in interfaceTaggedUnion<Aggregation.Kind,
Object>
-
of
-
aggregations
Sub-aggregations for this aggregation. Only applies to bucket aggregations.API name:
aggregations
-
meta
API name:meta
-
isAdjacencyMatrix
public boolean isAdjacencyMatrix()Is this variant instance of kindadjacency_matrix
? -
adjacencyMatrix
Get theadjacency_matrix
variant value.- Throws:
IllegalStateException
- if the current variant is not of theadjacency_matrix
kind.
-
isAutoDateHistogram
public boolean isAutoDateHistogram()Is this variant instance of kindauto_date_histogram
? -
autoDateHistogram
Get theauto_date_histogram
variant value.- Throws:
IllegalStateException
- if the current variant is not of theauto_date_histogram
kind.
-
isAvg
public boolean isAvg()Is this variant instance of kindavg
? -
avg
Get theavg
variant value.- Throws:
IllegalStateException
- if the current variant is not of theavg
kind.
-
isAvgBucket
public boolean isAvgBucket()Is this variant instance of kindavg_bucket
? -
avgBucket
Get theavg_bucket
variant value.- Throws:
IllegalStateException
- if the current variant is not of theavg_bucket
kind.
-
isBoxplot
public boolean isBoxplot()Is this variant instance of kindboxplot
? -
boxplot
Get theboxplot
variant value.- Throws:
IllegalStateException
- if the current variant is not of theboxplot
kind.
-
isBucketScript
public boolean isBucketScript()Is this variant instance of kindbucket_script
? -
bucketScript
Get thebucket_script
variant value.- Throws:
IllegalStateException
- if the current variant is not of thebucket_script
kind.
-
isBucketSelector
public boolean isBucketSelector()Is this variant instance of kindbucket_selector
? -
bucketSelector
Get thebucket_selector
variant value.- Throws:
IllegalStateException
- if the current variant is not of thebucket_selector
kind.
-
isBucketSort
public boolean isBucketSort()Is this variant instance of kindbucket_sort
? -
bucketSort
Get thebucket_sort
variant value.- Throws:
IllegalStateException
- if the current variant is not of thebucket_sort
kind.
-
isCardinality
public boolean isCardinality()Is this variant instance of kindcardinality
? -
cardinality
Get thecardinality
variant value.- Throws:
IllegalStateException
- if the current variant is not of thecardinality
kind.
-
isChildren
public boolean isChildren()Is this variant instance of kindchildren
? -
children
Get thechildren
variant value.- Throws:
IllegalStateException
- if the current variant is not of thechildren
kind.
-
isComposite
public boolean isComposite()Is this variant instance of kindcomposite
? -
composite
Get thecomposite
variant value.- Throws:
IllegalStateException
- if the current variant is not of thecomposite
kind.
-
isCumulativeCardinality
public boolean isCumulativeCardinality()Is this variant instance of kindcumulative_cardinality
? -
cumulativeCardinality
Get thecumulative_cardinality
variant value.- Throws:
IllegalStateException
- if the current variant is not of thecumulative_cardinality
kind.
-
isCumulativeSum
public boolean isCumulativeSum()Is this variant instance of kindcumulative_sum
? -
cumulativeSum
Get thecumulative_sum
variant value.- Throws:
IllegalStateException
- if the current variant is not of thecumulative_sum
kind.
-
isDateHistogram
public boolean isDateHistogram()Is this variant instance of kinddate_histogram
? -
dateHistogram
Get thedate_histogram
variant value.- Throws:
IllegalStateException
- if the current variant is not of thedate_histogram
kind.
-
isDateRange
public boolean isDateRange()Is this variant instance of kinddate_range
? -
dateRange
Get thedate_range
variant value.- Throws:
IllegalStateException
- if the current variant is not of thedate_range
kind.
-
isDerivative
public boolean isDerivative()Is this variant instance of kindderivative
? -
derivative
Get thederivative
variant value.- Throws:
IllegalStateException
- if the current variant is not of thederivative
kind.
-
isDiversifiedSampler
public boolean isDiversifiedSampler()Is this variant instance of kinddiversified_sampler
? -
diversifiedSampler
Get thediversified_sampler
variant value.- Throws:
IllegalStateException
- if the current variant is not of thediversified_sampler
kind.
-
isExtendedStats
public boolean isExtendedStats()Is this variant instance of kindextended_stats
? -
extendedStats
Get theextended_stats
variant value.- Throws:
IllegalStateException
- if the current variant is not of theextended_stats
kind.
-
isExtendedStatsBucket
public boolean isExtendedStatsBucket()Is this variant instance of kindextended_stats_bucket
? -
extendedStatsBucket
Get theextended_stats_bucket
variant value.- Throws:
IllegalStateException
- if the current variant is not of theextended_stats_bucket
kind.
-
isFilter
public boolean isFilter()Is this variant instance of kindfilter
? -
filter
Get thefilter
variant value.- Throws:
IllegalStateException
- if the current variant is not of thefilter
kind.
-
isFilters
public boolean isFilters()Is this variant instance of kindfilters
? -
filters
Get thefilters
variant value.- Throws:
IllegalStateException
- if the current variant is not of thefilters
kind.
-
isGeoBounds
public boolean isGeoBounds()Is this variant instance of kindgeo_bounds
? -
geoBounds
Get thegeo_bounds
variant value.- Throws:
IllegalStateException
- if the current variant is not of thegeo_bounds
kind.
-
isGeoCentroid
public boolean isGeoCentroid()Is this variant instance of kindgeo_centroid
? -
geoCentroid
Get thegeo_centroid
variant value.- Throws:
IllegalStateException
- if the current variant is not of thegeo_centroid
kind.
-
isGeoDistance
public boolean isGeoDistance()Is this variant instance of kindgeo_distance
? -
geoDistance
Get thegeo_distance
variant value.- Throws:
IllegalStateException
- if the current variant is not of thegeo_distance
kind.
-
isGeohashGrid
public boolean isGeohashGrid()Is this variant instance of kindgeohash_grid
? -
geohashGrid
Get thegeohash_grid
variant value.- Throws:
IllegalStateException
- if the current variant is not of thegeohash_grid
kind.
-
isGeoLine
public boolean isGeoLine()Is this variant instance of kindgeo_line
? -
geoLine
Get thegeo_line
variant value.- Throws:
IllegalStateException
- if the current variant is not of thegeo_line
kind.
-
isGeotileGrid
public boolean isGeotileGrid()Is this variant instance of kindgeotile_grid
? -
geotileGrid
Get thegeotile_grid
variant value.- Throws:
IllegalStateException
- if the current variant is not of thegeotile_grid
kind.
-
isGlobal
public boolean isGlobal()Is this variant instance of kindglobal
? -
global
Get theglobal
variant value.- Throws:
IllegalStateException
- if the current variant is not of theglobal
kind.
-
isHistogram
public boolean isHistogram()Is this variant instance of kindhistogram
? -
histogram
Get thehistogram
variant value.- Throws:
IllegalStateException
- if the current variant is not of thehistogram
kind.
-
isIpRange
public boolean isIpRange()Is this variant instance of kindip_range
? -
ipRange
Get theip_range
variant value.- Throws:
IllegalStateException
- if the current variant is not of theip_range
kind.
-
isInference
public boolean isInference()Is this variant instance of kindinference
? -
inference
Get theinference
variant value.- Throws:
IllegalStateException
- if the current variant is not of theinference
kind.
-
isMatrixStats
public boolean isMatrixStats()Is this variant instance of kindmatrix_stats
? -
matrixStats
Get thematrix_stats
variant value.- Throws:
IllegalStateException
- if the current variant is not of thematrix_stats
kind.
-
isMax
public boolean isMax()Is this variant instance of kindmax
? -
max
Get themax
variant value.- Throws:
IllegalStateException
- if the current variant is not of themax
kind.
-
isMaxBucket
public boolean isMaxBucket()Is this variant instance of kindmax_bucket
? -
maxBucket
Get themax_bucket
variant value.- Throws:
IllegalStateException
- if the current variant is not of themax_bucket
kind.
-
isMedianAbsoluteDeviation
public boolean isMedianAbsoluteDeviation()Is this variant instance of kindmedian_absolute_deviation
? -
medianAbsoluteDeviation
Get themedian_absolute_deviation
variant value.- Throws:
IllegalStateException
- if the current variant is not of themedian_absolute_deviation
kind.
-
isMin
public boolean isMin()Is this variant instance of kindmin
? -
min
Get themin
variant value.- Throws:
IllegalStateException
- if the current variant is not of themin
kind.
-
isMinBucket
public boolean isMinBucket()Is this variant instance of kindmin_bucket
? -
minBucket
Get themin_bucket
variant value.- Throws:
IllegalStateException
- if the current variant is not of themin_bucket
kind.
-
isMissing
public boolean isMissing()Is this variant instance of kindmissing
? -
missing
Get themissing
variant value.- Throws:
IllegalStateException
- if the current variant is not of themissing
kind.
-
isMovingAvg
public boolean isMovingAvg()Is this variant instance of kindmoving_avg
? -
movingAvg
Get themoving_avg
variant value.- Throws:
IllegalStateException
- if the current variant is not of themoving_avg
kind.
-
isMovingPercentiles
public boolean isMovingPercentiles()Is this variant instance of kindmoving_percentiles
? -
movingPercentiles
Get themoving_percentiles
variant value.- Throws:
IllegalStateException
- if the current variant is not of themoving_percentiles
kind.
-
isMovingFn
public boolean isMovingFn()Is this variant instance of kindmoving_fn
? -
movingFn
Get themoving_fn
variant value.- Throws:
IllegalStateException
- if the current variant is not of themoving_fn
kind.
-
isMultiTerms
public boolean isMultiTerms()Is this variant instance of kindmulti_terms
? -
multiTerms
Get themulti_terms
variant value.- Throws:
IllegalStateException
- if the current variant is not of themulti_terms
kind.
-
isNested
public boolean isNested()Is this variant instance of kindnested
? -
nested
Get thenested
variant value.- Throws:
IllegalStateException
- if the current variant is not of thenested
kind.
-
isNormalize
public boolean isNormalize()Is this variant instance of kindnormalize
? -
normalize
Get thenormalize
variant value.- Throws:
IllegalStateException
- if the current variant is not of thenormalize
kind.
-
isParent
public boolean isParent()Is this variant instance of kindparent
? -
parent
Get theparent
variant value.- Throws:
IllegalStateException
- if the current variant is not of theparent
kind.
-
isPercentileRanks
public boolean isPercentileRanks()Is this variant instance of kindpercentile_ranks
? -
percentileRanks
Get thepercentile_ranks
variant value.- Throws:
IllegalStateException
- if the current variant is not of thepercentile_ranks
kind.
-
isPercentiles
public boolean isPercentiles()Is this variant instance of kindpercentiles
? -
percentiles
Get thepercentiles
variant value.- Throws:
IllegalStateException
- if the current variant is not of thepercentiles
kind.
-
isPercentilesBucket
public boolean isPercentilesBucket()Is this variant instance of kindpercentiles_bucket
? -
percentilesBucket
Get thepercentiles_bucket
variant value.- Throws:
IllegalStateException
- if the current variant is not of thepercentiles_bucket
kind.
-
isRange
public boolean isRange()Is this variant instance of kindrange
? -
range
Get therange
variant value.- Throws:
IllegalStateException
- if the current variant is not of therange
kind.
-
isRareTerms
public boolean isRareTerms()Is this variant instance of kindrare_terms
? -
rareTerms
Get therare_terms
variant value.- Throws:
IllegalStateException
- if the current variant is not of therare_terms
kind.
-
isRate
public boolean isRate()Is this variant instance of kindrate
? -
rate
Get therate
variant value.- Throws:
IllegalStateException
- if the current variant is not of therate
kind.
-
isReverseNested
public boolean isReverseNested()Is this variant instance of kindreverse_nested
? -
reverseNested
Get thereverse_nested
variant value.- Throws:
IllegalStateException
- if the current variant is not of thereverse_nested
kind.
-
isSampler
public boolean isSampler()Is this variant instance of kindsampler
? -
sampler
Get thesampler
variant value.- Throws:
IllegalStateException
- if the current variant is not of thesampler
kind.
-
isScriptedMetric
public boolean isScriptedMetric()Is this variant instance of kindscripted_metric
? -
scriptedMetric
Get thescripted_metric
variant value.- Throws:
IllegalStateException
- if the current variant is not of thescripted_metric
kind.
-
isSerialDiff
public boolean isSerialDiff()Is this variant instance of kindserial_diff
? -
serialDiff
Get theserial_diff
variant value.- Throws:
IllegalStateException
- if the current variant is not of theserial_diff
kind.
-
isSignificantTerms
public boolean isSignificantTerms()Is this variant instance of kindsignificant_terms
? -
significantTerms
Get thesignificant_terms
variant value.- Throws:
IllegalStateException
- if the current variant is not of thesignificant_terms
kind.
-
isSignificantText
public boolean isSignificantText()Is this variant instance of kindsignificant_text
? -
significantText
Get thesignificant_text
variant value.- Throws:
IllegalStateException
- if the current variant is not of thesignificant_text
kind.
-
isStats
public boolean isStats()Is this variant instance of kindstats
? -
stats
Get thestats
variant value.- Throws:
IllegalStateException
- if the current variant is not of thestats
kind.
-
isStatsBucket
public boolean isStatsBucket()Is this variant instance of kindstats_bucket
? -
statsBucket
Get thestats_bucket
variant value.- Throws:
IllegalStateException
- if the current variant is not of thestats_bucket
kind.
-
isStringStats
public boolean isStringStats()Is this variant instance of kindstring_stats
? -
stringStats
Get thestring_stats
variant value.- Throws:
IllegalStateException
- if the current variant is not of thestring_stats
kind.
-
isSum
public boolean isSum()Is this variant instance of kindsum
? -
sum
Get thesum
variant value.- Throws:
IllegalStateException
- if the current variant is not of thesum
kind.
-
isSumBucket
public boolean isSumBucket()Is this variant instance of kindsum_bucket
? -
sumBucket
Get thesum_bucket
variant value.- Throws:
IllegalStateException
- if the current variant is not of thesum_bucket
kind.
-
isTerms
public boolean isTerms()Is this variant instance of kindterms
? -
terms
Get theterms
variant value.- Throws:
IllegalStateException
- if the current variant is not of theterms
kind.
-
isTopHits
public boolean isTopHits()Is this variant instance of kindtop_hits
? -
topHits
Get thetop_hits
variant value.- Throws:
IllegalStateException
- if the current variant is not of thetop_hits
kind.
-
isTTest
public boolean isTTest()Is this variant instance of kindt_test
? -
tTest
Get thet_test
variant value.- Throws:
IllegalStateException
- if the current variant is not of thet_test
kind.
-
isTopMetrics
public boolean isTopMetrics()Is this variant instance of kindtop_metrics
? -
topMetrics
Get thetop_metrics
variant value.- Throws:
IllegalStateException
- if the current variant is not of thetop_metrics
kind.
-
isValueCount
public boolean isValueCount()Is this variant instance of kindvalue_count
? -
valueCount
Get thevalue_count
variant value.- Throws:
IllegalStateException
- if the current variant is not of thevalue_count
kind.
-
isWeightedAvg
public boolean isWeightedAvg()Is this variant instance of kindweighted_avg
? -
weightedAvg
Get theweighted_avg
variant value.- Throws:
IllegalStateException
- if the current variant is not of theweighted_avg
kind.
-
isVariableWidthHistogram
public boolean isVariableWidthHistogram()Is this variant instance of kindvariable_width_histogram
? -
variableWidthHistogram
Get thevariable_width_histogram
variant value.- Throws:
IllegalStateException
- if the current variant is not of thevariable_width_histogram
kind.
-
_isCustom
public boolean _isCustom()Is this a customAggregation
defined by a plugin? -
_customKind
Get the actual kind when_kind()
equalsAggregation.Kind._Custom
(plugin-defined variant).- Specified by:
_customKind
in interfaceOpenTaggedUnion<Aggregation.Kind,
Object>
-
_custom
Get the custom plugin-defined variant value.- Throws:
IllegalStateException
- if the current variant is notAggregation.Kind._Custom
.
-
serialize
- Specified by:
serialize
in interfaceJsonpSerializable
-
toString
-
setupAggregationDeserializer
-