Class Aggregate
java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.Aggregate
- All Implemented Interfaces:
JsonpSerializable
,OpenTaggedUnion<Aggregate.Kind,
,Object> TaggedUnion<Aggregate.Kind,
Object>
public class Aggregate
extends Object
implements OpenTaggedUnion<Aggregate.Kind,Object>, JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final ExternallyTaggedUnion.TypedKeysDeserializer<Aggregate>
-
Constructor Summary
ConstructorDescriptionAggregate
(AggregateVariant value) Build a custom plugin-definedAggregate
, given its kind and some JSON data -
Method Summary
Modifier and TypeMethodDescription_custom()
Get the custom plugin-defined variant value.final String
Get the actual kind when_kind()
equalsAggregate.Kind._Custom
(plugin-defined variant).final Object
_get()
boolean
Is this a customAggregate
defined by a plugin?final Aggregate.Kind
_kind()
Get the of the kind of variant held by this object.Get theadjacency_matrix
variant value.Get theauto_date_histogram
variant value.avg()
Get theavg
variant value.boxPlot()
Get thebox_plot
variant value.Get thebucket_metric_value
variant value.Get thecardinality
variant value.children()
Get thechildren
variant value.Get thecomposite
variant value.Get thedate_histogram
variant value.Get thedate_range
variant value.Get thederivative
variant value.dterms()
Get thedterms
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 thehdr_percentile_ranks
variant value.Get thehdr_percentiles
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 kindbox_plot
?boolean
Is this variant instance of kindbucket_metric_value
?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 kinddate_histogram
?boolean
Is this variant instance of kinddate_range
?boolean
Is this variant instance of kindderivative
?boolean
isDterms()
Is this variant instance of kinddterms
?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 kindhdr_percentile_ranks
?boolean
Is this variant instance of kindhdr_percentiles
?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 kindlrareterms
?boolean
isLterms()
Is this variant instance of kindlterms
?boolean
Is this variant instance of kindmatrix_stats
?boolean
isMax()
Is this variant instance of kindmax
?boolean
Is this variant instance of kindmedian_absolute_deviation
?boolean
isMin()
Is this variant instance of kindmin
?boolean
Is this variant instance of kindmissing
?boolean
Is this variant instance of kindmulti_terms
?boolean
isNested()
Is this variant instance of kindnested
?boolean
isParent()
Is this variant instance of kindparent
?boolean
Is this variant instance of kindpercentiles_bucket
?boolean
isRange()
Is this variant instance of kindrange
?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 kindsiglterms
?boolean
Is this variant instance of kindsigsterms
?boolean
Is this variant instance of kindsimple_long_value
?boolean
Is this variant instance of kindsimple_value
?boolean
Is this variant instance of kindsrareterms
?boolean
isStats()
Is this variant instance of kindstats
?boolean
Is this variant instance of kindstats_bucket
?boolean
isSterms()
Is this variant instance of kindsterms
?boolean
Is this variant instance of kindstring_stats
?boolean
isSum()
Is this variant instance of kindsum
?boolean
Is this variant instance of kindtdigest_percentile_ranks
?boolean
Is this variant instance of kindtdigest_percentiles
?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 kindumrareterms
?boolean
Is this variant instance of kindumsigterms
?boolean
Is this variant instance of kindumterms
?boolean
Is this variant instance of kindunmapped_sampler
?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 thelrareterms
variant value.lterms()
Get thelterms
variant value.Get thematrix_stats
variant value.max()
Get themax
variant value.Get themedian_absolute_deviation
variant value.min()
Get themin
variant value.missing()
Get themissing
variant value.Get themulti_terms
variant value.nested()
Get thenested
variant value.static Aggregate
parent()
Get theparent
variant value.Get thepercentiles_bucket
variant value.range()
Get therange
variant value.rate()
Get therate
variant value.Get thereverse_nested
variant value.sampler()
Get thesampler
variant value.Get thescripted_metric
variant value.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Get thesiglterms
variant value.Get thesigsterms
variant value.Get thesimple_long_value
variant value.Get thesimple_value
variant value.Get thesrareterms
variant value.stats()
Get thestats
variant value.Get thestats_bucket
variant value.sterms()
Get thesterms
variant value.Get thestring_stats
variant value.sum()
Get thesum
variant value.Get thetdigest_percentile_ranks
variant value.Get thetdigest_percentiles
variant value.topHits()
Get thetop_hits
variant value.Get thetop_metrics
variant value.toString()
tTest()
Get thet_test
variant value.Get theumrareterms
variant value.Get theumsigterms
variant value.umterms()
Get theumterms
variant value.Get theunmapped_sampler
variant value.Get thevalue_count
variant value.Get thevariable_width_histogram
variant value.Get theweighted_avg
variant value.
-
Field Details
-
_TYPED_KEYS_DESERIALIZER
-
-
Constructor Details
-
Aggregate
-
Aggregate
Build a custom plugin-definedAggregate
, given its kind and some JSON data
-
-
Method Details
-
_kind
Description copied from interface:TaggedUnion
Get the of the kind of variant held by this object.- Specified by:
_kind
in interfaceTaggedUnion<Aggregate.Kind,
Object> - Returns:
- the variant kind
-
_get
- Specified by:
_get
in interfaceTaggedUnion<Aggregate.Kind,
Object>
-
of
-
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.
-
isBoxPlot
public boolean isBoxPlot()Is this variant instance of kindbox_plot
? -
boxPlot
Get thebox_plot
variant value.- Throws:
IllegalStateException
- if the current variant is not of thebox_plot
kind.
-
isBucketMetricValue
public boolean isBucketMetricValue()Is this variant instance of kindbucket_metric_value
? -
bucketMetricValue
Get thebucket_metric_value
variant value.- Throws:
IllegalStateException
- if the current variant is not of thebucket_metric_value
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.
-
isSimpleLongValue
public boolean isSimpleLongValue()Is this variant instance of kindsimple_long_value
? -
simpleLongValue
Get thesimple_long_value
variant value.- Throws:
IllegalStateException
- if the current variant is not of thesimple_long_value
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.
-
isDterms
public boolean isDterms()Is this variant instance of kinddterms
? -
dterms
Get thedterms
variant value.- Throws:
IllegalStateException
- if the current variant is not of thedterms
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.
-
isHdrPercentileRanks
public boolean isHdrPercentileRanks()Is this variant instance of kindhdr_percentile_ranks
? -
hdrPercentileRanks
Get thehdr_percentile_ranks
variant value.- Throws:
IllegalStateException
- if the current variant is not of thehdr_percentile_ranks
kind.
-
isHdrPercentiles
public boolean isHdrPercentiles()Is this variant instance of kindhdr_percentiles
? -
hdrPercentiles
Get thehdr_percentiles
variant value.- Throws:
IllegalStateException
- if the current variant is not of thehdr_percentiles
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.
-
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.
-
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.
-
isLrareterms
public boolean isLrareterms()Is this variant instance of kindlrareterms
? -
lrareterms
Get thelrareterms
variant value.- Throws:
IllegalStateException
- if the current variant is not of thelrareterms
kind.
-
isLterms
public boolean isLterms()Is this variant instance of kindlterms
? -
lterms
Get thelterms
variant value.- Throws:
IllegalStateException
- if the current variant is not of thelterms
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
isSiglterms
public boolean isSiglterms()Is this variant instance of kindsiglterms
? -
siglterms
Get thesiglterms
variant value.- Throws:
IllegalStateException
- if the current variant is not of thesiglterms
kind.
-
isSigsterms
public boolean isSigsterms()Is this variant instance of kindsigsterms
? -
sigsterms
Get thesigsterms
variant value.- Throws:
IllegalStateException
- if the current variant is not of thesigsterms
kind.
-
isSimpleValue
public boolean isSimpleValue()Is this variant instance of kindsimple_value
? -
simpleValue
Get thesimple_value
variant value.- Throws:
IllegalStateException
- if the current variant is not of thesimple_value
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.
-
isSrareterms
public boolean isSrareterms()Is this variant instance of kindsrareterms
? -
srareterms
Get thesrareterms
variant value.- Throws:
IllegalStateException
- if the current variant is not of thesrareterms
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.
-
isSterms
public boolean isSterms()Is this variant instance of kindsterms
? -
sterms
Get thesterms
variant value.- Throws:
IllegalStateException
- if the current variant is not of thesterms
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.
-
isTdigestPercentileRanks
public boolean isTdigestPercentileRanks()Is this variant instance of kindtdigest_percentile_ranks
? -
tdigestPercentileRanks
Get thetdigest_percentile_ranks
variant value.- Throws:
IllegalStateException
- if the current variant is not of thetdigest_percentile_ranks
kind.
-
isTdigestPercentiles
public boolean isTdigestPercentiles()Is this variant instance of kindtdigest_percentiles
? -
tdigestPercentiles
Get thetdigest_percentiles
variant value.- Throws:
IllegalStateException
- if the current variant is not of thetdigest_percentiles
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.
-
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.
-
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.
-
isUmrareterms
public boolean isUmrareterms()Is this variant instance of kindumrareterms
? -
umrareterms
Get theumrareterms
variant value.- Throws:
IllegalStateException
- if the current variant is not of theumrareterms
kind.
-
isUnmappedSampler
public boolean isUnmappedSampler()Is this variant instance of kindunmapped_sampler
? -
unmappedSampler
Get theunmapped_sampler
variant value.- Throws:
IllegalStateException
- if the current variant is not of theunmapped_sampler
kind.
-
isUmsigterms
public boolean isUmsigterms()Is this variant instance of kindumsigterms
? -
umsigterms
Get theumsigterms
variant value.- Throws:
IllegalStateException
- if the current variant is not of theumsigterms
kind.
-
isUmterms
public boolean isUmterms()Is this variant instance of kindumterms
? -
umterms
Get theumterms
variant value.- Throws:
IllegalStateException
- if the current variant is not of theumterms
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.
-
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.
-
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.
-
_isCustom
public boolean _isCustom()Is this a customAggregate
defined by a plugin? -
_customKind
Get the actual kind when_kind()
equalsAggregate.Kind._Custom
(plugin-defined variant).- Specified by:
_customKind
in interfaceOpenTaggedUnion<Aggregate.Kind,
Object>
-
_custom
Get the custom plugin-defined variant value.- Throws:
IllegalStateException
- if the current variant is notAggregate.Kind._Custom
.
-
serialize
- Specified by:
serialize
in interfaceJsonpSerializable
-
toString
-