java.lang.Object

org.opensearch.client.util.TaggedUnion<AggregationContainer.Tag,java.lang.Object>

org.opensearch.client.opensearch._types.aggregations.AggregationContainer

All Implemented Interfaces:: ToJsonp

public class AggregationContainer
extends TaggedUnion<AggregationContainer.Tag,java.lang.Object>
implements ToJsonp

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class AggregationContainer.Builder

static class AggregationContainer.Tag
Field Summary

Fields

Modifier and Type Field Description

static JsonpDeserializer<AggregationContainer> DESERIALIZER

Fields inherited from class org.opensearch.client.util.TaggedUnion
tag, value

Method Summary

Modifier and Type	Method	Description
`AdjacencyMatrixAggregation`	`adjacencyMatrix()`	Get the `adjacency_matrix` variant value.
`java.util.Map<java.lang.String,AggregationContainer>`	`aggregations()`	Get the `aggregations` variant value.
`java.util.Map<java.lang.String,AggregationContainer>`	`aggs()`	API name: `aggs`
`AutoDateHistogramAggregation`	`autoDateHistogram()`	Get the `auto_date_histogram` variant value.
`jakarta.json.JsonValue`	`avg()`	Get the `avg` variant value.
`jakarta.json.JsonValue`	`avgBucket()`	Get the `avg_bucket` variant value.
`BoxplotAggregation`	`boxplot()`	Get the `boxplot` variant value.
`BucketScriptAggregation`	`bucketScript()`	Get the `bucket_script` variant value.
`BucketSelectorAggregation`	`bucketSelector()`	Get the `bucket_selector` variant value.
`BucketSortAggregation`	`bucketSort()`	Get the `bucket_sort` variant value.
`CardinalityAggregation`	`cardinality()`	Get the `cardinality` variant value.
`ChildrenAggregation`	`children()`	Get the `children` variant value.
`CompositeAggregation`	`composite()`	Get the `composite` variant value.
`jakarta.json.JsonValue`	`cumulativeCardinality()`	Get the `cumulative_cardinality` variant value.
`jakarta.json.JsonValue`	`cumulativeSum()`	Get the `cumulative_sum` variant value.
`DateHistogramAggregation`	`dateHistogram()`	Get the `date_histogram` variant value.
`DateRangeAggregation`	`dateRange()`	Get the `date_range` variant value.
`jakarta.json.JsonValue`	`derivative()`	Get the `derivative` variant value.
`DiversifiedSamplerAggregation`	`diversifiedSampler()`	Get the `diversified_sampler` variant value.
`ExtendedStatsAggregation`	`extendedStats()`	Get the `extended_stats` variant value.
`ExtendedStatsBucketAggregation`	`extendedStatsBucket()`	Get the `extended_stats_bucket` variant value.
`QueryContainer`	`filter()`	Get the `filter` variant value.
`FiltersAggregation`	`filters()`	Get the `filters` variant value.
`GeoBoundsAggregation`	`geoBounds()`	Get the `geo_bounds` variant value.
`GeoCentroidAggregation`	`geoCentroid()`	Get the `geo_centroid` variant value.
`GeoDistanceAggregation`	`geoDistance()`	Get the `geo_distance` variant value.
`GeoHashGridAggregation`	`geohashGrid()`	Get the `geohash_grid` variant value.
`GeoLineAggregation`	`geoLine()`	Get the `geo_line` variant value.
`GeoTileGridAggregation`	`geotileGrid()`	Get the `geotile_grid` variant value.
`jakarta.json.JsonValue`	`global()`	Get the `global` variant value.
`HistogramAggregation`	`histogram()`	Get the `histogram` variant value.
`InferenceAggregation`	`inference()`	Get the `inference` variant value.
`IpRangeAggregation`	`ipRange()`	Get the `ip_range` variant value.
`boolean`	`isAdjacencyMatrix()`	Is this `AggregationContainer` of a `adjacency_matrix` kind?
`boolean`	`isAggregations()`	Is this `AggregationContainer` of a `aggregations` kind?
`boolean`	`isAutoDateHistogram()`	Is this `AggregationContainer` of a `auto_date_histogram` kind?
`boolean`	`isAvg()`	Is this `AggregationContainer` of a `avg` kind?
`boolean`	`isAvgBucket()`	Is this `AggregationContainer` of a `avg_bucket` kind?
`boolean`	`isBoxplot()`	Is this `AggregationContainer` of a `boxplot` kind?
`boolean`	`isBucketScript()`	Is this `AggregationContainer` of a `bucket_script` kind?
`boolean`	`isBucketSelector()`	Is this `AggregationContainer` of a `bucket_selector` kind?
`boolean`	`isBucketSort()`	Is this `AggregationContainer` of a `bucket_sort` kind?
`boolean`	`isCardinality()`	Is this `AggregationContainer` of a `cardinality` kind?
`boolean`	`isChildren()`	Is this `AggregationContainer` of a `children` kind?
`boolean`	`isComposite()`	Is this `AggregationContainer` of a `composite` kind?
`boolean`	`isCumulativeCardinality()`	Is this `AggregationContainer` of a `cumulative_cardinality` kind?
`boolean`	`isCumulativeSum()`	Is this `AggregationContainer` of a `cumulative_sum` kind?
`boolean`	`isDateHistogram()`	Is this `AggregationContainer` of a `date_histogram` kind?
`boolean`	`isDateRange()`	Is this `AggregationContainer` of a `date_range` kind?
`boolean`	`isDerivative()`	Is this `AggregationContainer` of a `derivative` kind?
`boolean`	`isDiversifiedSampler()`	Is this `AggregationContainer` of a `diversified_sampler` kind?
`boolean`	`isExtendedStats()`	Is this `AggregationContainer` of a `extended_stats` kind?
`boolean`	`isExtendedStatsBucket()`	Is this `AggregationContainer` of a `extended_stats_bucket` kind?
`boolean`	`isFilter()`	Is this `AggregationContainer` of a `filter` kind?
`boolean`	`isFilters()`	Is this `AggregationContainer` of a `filters` kind?
`boolean`	`isGeoBounds()`	Is this `AggregationContainer` of a `geo_bounds` kind?
`boolean`	`isGeoCentroid()`	Is this `AggregationContainer` of a `geo_centroid` kind?
`boolean`	`isGeoDistance()`	Is this `AggregationContainer` of a `geo_distance` kind?
`boolean`	`isGeohashGrid()`	Is this `AggregationContainer` of a `geohash_grid` kind?
`boolean`	`isGeoLine()`	Is this `AggregationContainer` of a `geo_line` kind?
`boolean`	`isGeotileGrid()`	Is this `AggregationContainer` of a `geotile_grid` kind?
`boolean`	`isGlobal()`	Is this `AggregationContainer` of a `global` kind?
`boolean`	`isHistogram()`	Is this `AggregationContainer` of a `histogram` kind?
`boolean`	`isInference()`	Is this `AggregationContainer` of a `inference` kind?
`boolean`	`isIpRange()`	Is this `AggregationContainer` of a `ip_range` kind?
`boolean`	`isLine()`	Is this `AggregationContainer` of a `line` kind?
`boolean`	`isMatrixStats()`	Is this `AggregationContainer` of a `matrix_stats` kind?
`boolean`	`isMax()`	Is this `AggregationContainer` of a `max` kind?
`boolean`	`isMaxBucket()`	Is this `AggregationContainer` of a `max_bucket` kind?
`boolean`	`isMedianAbsoluteDeviation()`	Is this `AggregationContainer` of a `median_absolute_deviation` kind?
`boolean`	`isMin()`	Is this `AggregationContainer` of a `min` kind?
`boolean`	`isMinBucket()`	Is this `AggregationContainer` of a `min_bucket` kind?
`boolean`	`isMissing()`	Is this `AggregationContainer` of a `missing` kind?
`boolean`	`isMovingAvg()`	Is this `AggregationContainer` of a `moving_avg` kind?
`boolean`	`isMovingFn()`	Is this `AggregationContainer` of a `moving_fn` kind?
`boolean`	`isMovingPercentiles()`	Is this `AggregationContainer` of a `moving_percentiles` kind?
`boolean`	`isMultiTerms()`	Is this `AggregationContainer` of a `multi_terms` kind?
`boolean`	`isNested()`	Is this `AggregationContainer` of a `nested` kind?
`boolean`	`isNormalize()`	Is this `AggregationContainer` of a `normalize` kind?
`boolean`	`isParent()`	Is this `AggregationContainer` of a `parent` kind?
`boolean`	`isPercentileRanks()`	Is this `AggregationContainer` of a `percentile_ranks` kind?
`boolean`	`isPercentiles()`	Is this `AggregationContainer` of a `percentiles` kind?
`boolean`	`isPercentilesBucket()`	Is this `AggregationContainer` of a `percentiles_bucket` kind?
`boolean`	`isRange()`	Is this `AggregationContainer` of a `range` kind?
`boolean`	`isRareTerms()`	Is this `AggregationContainer` of a `rare_terms` kind?
`boolean`	`isRate()`	Is this `AggregationContainer` of a `rate` kind?
`boolean`	`isReverseNested()`	Is this `AggregationContainer` of a `reverse_nested` kind?
`boolean`	`isSampler()`	Is this `AggregationContainer` of a `sampler` kind?
`boolean`	`isScriptedMetric()`	Is this `AggregationContainer` of a `scripted_metric` kind?
`boolean`	`isSerialDiff()`	Is this `AggregationContainer` of a `serial_diff` kind?
`boolean`	`isSignificantTerms()`	Is this `AggregationContainer` of a `significant_terms` kind?
`boolean`	`isSignificantText()`	Is this `AggregationContainer` of a `significant_text` kind?
`boolean`	`isStats()`	Is this `AggregationContainer` of a `stats` kind?
`boolean`	`isStatsBucket()`	Is this `AggregationContainer` of a `stats_bucket` kind?
`boolean`	`isStringStats()`	Is this `AggregationContainer` of a `string_stats` kind?
`boolean`	`isSum()`	Is this `AggregationContainer` of a `sum` kind?
`boolean`	`isSumBucket()`	Is this `AggregationContainer` of a `sum_bucket` kind?
`boolean`	`isTerms()`	Is this `AggregationContainer` of a `terms` kind?
`boolean`	`isTopHits()`	Is this `AggregationContainer` of a `top_hits` kind?
`boolean`	`isTopMetrics()`	Is this `AggregationContainer` of a `top_metrics` kind?
`boolean`	`isTTest()`	Is this `AggregationContainer` of a `t_test` kind?
`boolean`	`isValueCount()`	Is this `AggregationContainer` of a `value_count` kind?
`boolean`	`isVariableWidthHistogram()`	Is this `AggregationContainer` of a `variable_width_histogram` kind?
`boolean`	`isWeightedAvg()`	Is this `AggregationContainer` of a `weighted_avg` kind?
`GeoLineAggregation`	`line()`	Get the `line` variant value.
`MatrixStatsAggregation`	`matrixStats()`	Get the `matrix_stats` variant value.
`jakarta.json.JsonValue`	`max()`	Get the `max` variant value.
`jakarta.json.JsonValue`	`maxBucket()`	Get the `max_bucket` variant value.
`MedianAbsoluteDeviationAggregation`	`medianAbsoluteDeviation()`	Get the `median_absolute_deviation` variant value.
`java.util.Map<java.lang.String,jakarta.json.JsonValue>`	`meta()`	API name: `meta`
`jakarta.json.JsonValue`	`min()`	Get the `min` variant value.
`jakarta.json.JsonValue`	`minBucket()`	Get the `min_bucket` variant value.
`MissingAggregation`	`missing()`	Get the `missing` variant value.
`MovingAverageAggregation`	`movingAvg()`	Get the `moving_avg` variant value.
`MovingFunctionAggregation`	`movingFn()`	Get the `moving_fn` variant value.
`MovingPercentilesAggregation`	`movingPercentiles()`	Get the `moving_percentiles` variant value.
`MultiTermsAggregation`	`multiTerms()`	Get the `multi_terms` variant value.
`NestedAggregation`	`nested()`	Get the `nested` variant value.
`NormalizeAggregation`	`normalize()`	Get the `normalize` variant value.
`ParentAggregation`	`parent()`	Get the `parent` variant value.
`PercentileRanksAggregation`	`percentileRanks()`	Get the `percentile_ranks` variant value.
`PercentilesAggregation`	`percentiles()`	Get the `percentiles` variant value.
`PercentilesBucketAggregation`	`percentilesBucket()`	Get the `percentiles_bucket` variant value.
`RangeAggregation`	`range()`	Get the `range` variant value.
`RareTermsAggregation`	`rareTerms()`	Get the `rare_terms` variant value.
`RateAggregation`	`rate()`	Get the `rate` variant value.
`ReverseNestedAggregation`	`reverseNested()`	Get the `reverse_nested` variant value.
`SamplerAggregation`	`sampler()`	Get the `sampler` variant value.
`ScriptedMetricAggregation`	`scriptedMetric()`	Get the `scripted_metric` variant value.
`SerialDifferencingAggregation`	`serialDiff()`	Get the `serial_diff` variant value.
`SignificantTermsAggregation`	`significantTerms()`	Get the `significant_terms` variant value.
`SignificantTextAggregation`	`significantText()`	Get the `significant_text` variant value.
`jakarta.json.JsonValue`	`stats()`	Get the `stats` variant value.
`jakarta.json.JsonValue`	`statsBucket()`	Get the `stats_bucket` variant value.
`StringStatsAggregation`	`stringStats()`	Get the `string_stats` variant value.
`jakarta.json.JsonValue`	`sum()`	Get the `sum` variant value.
`jakarta.json.JsonValue`	`sumBucket()`	Get the `sum_bucket` variant value.
`TermsAggregation`	`terms()`	Get the `terms` variant value.
`void`	`toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`TopHitsAggregation`	`topHits()`	Get the `top_hits` variant value.
`TopMetricsAggregation`	`topMetrics()`	Get the `top_metrics` variant value.
`TTestAggregation`	`tTest()`	Get the `t_test` variant value.
`jakarta.json.JsonValue`	`valueCount()`	Get the `value_count` variant value.
`VariableWidthHistogramAggregation`	`variableWidthHistogram()`	Get the `variable_width_histogram` variant value.
`WeightedAverageAggregation`	`weightedAvg()`	Get the `weighted_avg` variant value.

Methods inherited from class org.opensearch.client.util.TaggedUnion

get, is

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- DESERIALIZER
  
  public static final JsonpDeserializer<AggregationContainer> DESERIALIZER
Method Details
- aggs
  
  @Nullable public java.util.Map<java.lang.String,AggregationContainer> aggs()
  
  API name: aggs
- meta
  
  @Nullable public java.util.Map<java.lang.String,jakarta.json.JsonValue> meta()
  
  API name: meta
- isAdjacencyMatrix
  
  public boolean isAdjacencyMatrix()
  
  Is this AggregationContainer of a adjacency_matrix kind?
- adjacencyMatrix
  
  public AdjacencyMatrixAggregation adjacencyMatrix()
  
  Get the adjacency_matrix variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the adjacency_matrix kind.
- isAggregations
  
  public boolean isAggregations()
  
  Is this AggregationContainer of a aggregations kind?
- aggregations
  
  public java.util.Map<java.lang.String,AggregationContainer> aggregations()
  
  Get the aggregations variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the aggregations kind.
- isAutoDateHistogram
  
  public boolean isAutoDateHistogram()
  
  Is this AggregationContainer of a auto_date_histogram kind?
- autoDateHistogram
  
  public AutoDateHistogramAggregation autoDateHistogram()
  
  Get the auto_date_histogram variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the auto_date_histogram kind.
- isAvg
  
  public boolean isAvg()
  
  Is this AggregationContainer of a avg kind?
- avg
  
  public jakarta.json.JsonValue avg()
  
  Get the avg variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the avg kind.
- isAvgBucket
  
  public boolean isAvgBucket()
  
  Is this AggregationContainer of a avg_bucket kind?
- avgBucket
  
  public jakarta.json.JsonValue avgBucket()
  
  Get the avg_bucket variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the avg_bucket kind.
- isBoxplot
  
  public boolean isBoxplot()
  
  Is this AggregationContainer of a boxplot kind?
- boxplot
  
  public BoxplotAggregation boxplot()
  
  Get the boxplot variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the boxplot kind.
- isBucketScript
  
  public boolean isBucketScript()
  
  Is this AggregationContainer of a bucket_script kind?
- bucketScript
  
  public BucketScriptAggregation bucketScript()
  
  Get the bucket_script variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the bucket_script kind.
- isBucketSelector
  
  public boolean isBucketSelector()
  
  Is this AggregationContainer of a bucket_selector kind?
- bucketSelector
  
  public BucketSelectorAggregation bucketSelector()
  
  Get the bucket_selector variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the bucket_selector kind.
- isBucketSort
  
  public boolean isBucketSort()
  
  Is this AggregationContainer of a bucket_sort kind?
- bucketSort
  
  public BucketSortAggregation bucketSort()
  
  Get the bucket_sort variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the bucket_sort kind.
- isCardinality
  
  public boolean isCardinality()
  
  Is this AggregationContainer of a cardinality kind?
- cardinality
  
  public CardinalityAggregation cardinality()
  
  Get the cardinality variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the cardinality kind.
- isChildren
  
  public boolean isChildren()
  
  Is this AggregationContainer of a children kind?
- children
  
  public ChildrenAggregation children()
  
  Get the children variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the children kind.
- isComposite
  
  public boolean isComposite()
  
  Is this AggregationContainer of a composite kind?
- composite
  
  public CompositeAggregation composite()
  
  Get the composite variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the composite kind.
- isCumulativeCardinality
  
  public boolean isCumulativeCardinality()
  
  Is this AggregationContainer of a cumulative_cardinality kind?
- cumulativeCardinality
  
  public jakarta.json.JsonValue cumulativeCardinality()
  
  Get the cumulative_cardinality variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the cumulative_cardinality kind.
- isCumulativeSum
  
  public boolean isCumulativeSum()
  
  Is this AggregationContainer of a cumulative_sum kind?
- cumulativeSum
  
  public jakarta.json.JsonValue cumulativeSum()
  
  Get the cumulative_sum variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the cumulative_sum kind.
- isDateHistogram
  
  public boolean isDateHistogram()
  
  Is this AggregationContainer of a date_histogram kind?
- dateHistogram
  
  public DateHistogramAggregation dateHistogram()
  
  Get the date_histogram variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the date_histogram kind.
- isDateRange
  
  public boolean isDateRange()
  
  Is this AggregationContainer of a date_range kind?
- dateRange
  
  public DateRangeAggregation dateRange()
  
  Get the date_range variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the date_range kind.
- isDerivative
  
  public boolean isDerivative()
  
  Is this AggregationContainer of a derivative kind?
- derivative
  
  public jakarta.json.JsonValue derivative()
  
  Get the derivative variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the derivative kind.
- isDiversifiedSampler
  
  public boolean isDiversifiedSampler()
  
  Is this AggregationContainer of a diversified_sampler kind?
- diversifiedSampler
  
  public DiversifiedSamplerAggregation diversifiedSampler()
  
  Get the diversified_sampler variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the diversified_sampler kind.
- isExtendedStats
  
  public boolean isExtendedStats()
  
  Is this AggregationContainer of a extended_stats kind?
- extendedStats
  
  public ExtendedStatsAggregation extendedStats()
  
  Get the extended_stats variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the extended_stats kind.
- isExtendedStatsBucket
  
  public boolean isExtendedStatsBucket()
  
  Is this AggregationContainer of a extended_stats_bucket kind?
- extendedStatsBucket
  
  public ExtendedStatsBucketAggregation extendedStatsBucket()
  
  Get the extended_stats_bucket variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the extended_stats_bucket kind.
- isFilter
  
  public boolean isFilter()
  
  Is this AggregationContainer of a filter kind?
- filter
  
  public QueryContainer filter()
  
  Get the filter variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the filter kind.
- isFilters
  
  public boolean isFilters()
  
  Is this AggregationContainer of a filters kind?
- filters
  
  public FiltersAggregation filters()
  
  Get the filters variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the filters kind.
- isGeoBounds
  
  public boolean isGeoBounds()
  
  Is this AggregationContainer of a geo_bounds kind?
- geoBounds
  
  public GeoBoundsAggregation geoBounds()
  
  Get the geo_bounds variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the geo_bounds kind.
- isGeoCentroid
  
  public boolean isGeoCentroid()
  
  Is this AggregationContainer of a geo_centroid kind?
- geoCentroid
  
  public GeoCentroidAggregation geoCentroid()
  
  Get the geo_centroid variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the geo_centroid kind.
- isGeoDistance
  
  public boolean isGeoDistance()
  
  Is this AggregationContainer of a geo_distance kind?
- geoDistance
  
  public GeoDistanceAggregation geoDistance()
  
  Get the geo_distance variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the geo_distance kind.
- isGeohashGrid
  
  public boolean isGeohashGrid()
  
  Is this AggregationContainer of a geohash_grid kind?
- geohashGrid
  
  public GeoHashGridAggregation geohashGrid()
  
  Get the geohash_grid variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the geohash_grid kind.
- isGeoLine
  
  public boolean isGeoLine()
  
  Is this AggregationContainer of a geo_line kind?
- geoLine
  
  public GeoLineAggregation geoLine()
  
  Get the geo_line variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the geo_line kind.
- isGeotileGrid
  
  public boolean isGeotileGrid()
  
  Is this AggregationContainer of a geotile_grid kind?
- geotileGrid
  
  public GeoTileGridAggregation geotileGrid()
  
  Get the geotile_grid variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the geotile_grid kind.
- isGlobal
  
  public boolean isGlobal()
  
  Is this AggregationContainer of a global kind?
- global
  
  public jakarta.json.JsonValue global()
  
  Get the global variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the global kind.
- isHistogram
  
  public boolean isHistogram()
  
  Is this AggregationContainer of a histogram kind?
- histogram
  
  public HistogramAggregation histogram()
  
  Get the histogram variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the histogram kind.
- isIpRange
  
  public boolean isIpRange()
  
  Is this AggregationContainer of a ip_range kind?
- ipRange
  
  public IpRangeAggregation ipRange()
  
  Get the ip_range variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the ip_range kind.
- isInference
  
  public boolean isInference()
  
  Is this AggregationContainer of a inference kind?
- inference
  
  public InferenceAggregation inference()
  
  Get the inference variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the inference kind.
- isLine
  
  public boolean isLine()
  
  Is this AggregationContainer of a line kind?
- line
  
  public GeoLineAggregation line()
  
  Get the line variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the line kind.
- isMatrixStats
  
  public boolean isMatrixStats()
  
  Is this AggregationContainer of a matrix_stats kind?
- matrixStats
  
  public MatrixStatsAggregation matrixStats()
  
  Get the matrix_stats variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the matrix_stats kind.
- isMax
  
  public boolean isMax()
  
  Is this AggregationContainer of a max kind?
- max
  
  public jakarta.json.JsonValue max()
  
  Get the max variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the max kind.
- isMaxBucket
  
  public boolean isMaxBucket()
  
  Is this AggregationContainer of a max_bucket kind?
- maxBucket
  
  public jakarta.json.JsonValue maxBucket()
  
  Get the max_bucket variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the max_bucket kind.
- isMedianAbsoluteDeviation
  
  public boolean isMedianAbsoluteDeviation()
  
  Is this AggregationContainer of a median_absolute_deviation kind?
- medianAbsoluteDeviation
  
  public MedianAbsoluteDeviationAggregation medianAbsoluteDeviation()
  
  Get the median_absolute_deviation variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the median_absolute_deviation kind.
- isMin
  
  public boolean isMin()
  
  Is this AggregationContainer of a min kind?
- min
  
  public jakarta.json.JsonValue min()
  
  Get the min variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the min kind.
- isMinBucket
  
  public boolean isMinBucket()
  
  Is this AggregationContainer of a min_bucket kind?
- minBucket
  
  public jakarta.json.JsonValue minBucket()
  
  Get the min_bucket variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the min_bucket kind.
- isMissing
  
  public boolean isMissing()
  
  Is this AggregationContainer of a missing kind?
- missing
  
  public MissingAggregation missing()
  
  Get the missing variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the missing kind.
- isMovingAvg
  
  public boolean isMovingAvg()
  
  Is this AggregationContainer of a moving_avg kind?
- movingAvg
  
  public MovingAverageAggregation movingAvg()
  
  Get the moving_avg variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the moving_avg kind.
- isMovingPercentiles
  
  public boolean isMovingPercentiles()
  
  Is this AggregationContainer of a moving_percentiles kind?
- movingPercentiles
  
  public MovingPercentilesAggregation movingPercentiles()
  
  Get the moving_percentiles variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the moving_percentiles kind.
- isMovingFn
  
  public boolean isMovingFn()
  
  Is this AggregationContainer of a moving_fn kind?
- movingFn
  
  public MovingFunctionAggregation movingFn()
  
  Get the moving_fn variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the moving_fn kind.
- isMultiTerms
  
  public boolean isMultiTerms()
  
  Is this AggregationContainer of a multi_terms kind?
- multiTerms
  
  public MultiTermsAggregation multiTerms()
  
  Get the multi_terms variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the multi_terms kind.
- isNested
  
  public boolean isNested()
  
  Is this AggregationContainer of a nested kind?
- nested
  
  public NestedAggregation nested()
  
  Get the nested variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the nested kind.
- isNormalize
  
  public boolean isNormalize()
  
  Is this AggregationContainer of a normalize kind?
- normalize
  
  public NormalizeAggregation normalize()
  
  Get the normalize variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the normalize kind.
- isParent
  
  public boolean isParent()
  
  Is this AggregationContainer of a parent kind?
- parent
  
  public ParentAggregation parent()
  
  Get the parent variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the parent kind.
- isPercentileRanks
  
  public boolean isPercentileRanks()
  
  Is this AggregationContainer of a percentile_ranks kind?
- percentileRanks
  
  public PercentileRanksAggregation percentileRanks()
  
  Get the percentile_ranks variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the percentile_ranks kind.
- isPercentiles
  
  public boolean isPercentiles()
  
  Is this AggregationContainer of a percentiles kind?
- percentiles
  
  public PercentilesAggregation percentiles()
  
  Get the percentiles variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the percentiles kind.
- isPercentilesBucket
  
  public boolean isPercentilesBucket()
  
  Is this AggregationContainer of a percentiles_bucket kind?
- percentilesBucket
  
  public PercentilesBucketAggregation percentilesBucket()
  
  Get the percentiles_bucket variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the percentiles_bucket kind.
- isRange
  
  public boolean isRange()
  
  Is this AggregationContainer of a range kind?
- range
  
  public RangeAggregation range()
  
  Get the range variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the range kind.
- isRareTerms
  
  public boolean isRareTerms()
  
  Is this AggregationContainer of a rare_terms kind?
- rareTerms
  
  public RareTermsAggregation rareTerms()
  
  Get the rare_terms variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the rare_terms kind.
- isRate
  
  public boolean isRate()
  
  Is this AggregationContainer of a rate kind?
- rate
  
  public RateAggregation rate()
  
  Get the rate variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the rate kind.
- isReverseNested
  
  public boolean isReverseNested()
  
  Is this AggregationContainer of a reverse_nested kind?
- reverseNested
  
  public ReverseNestedAggregation reverseNested()
  
  Get the reverse_nested variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the reverse_nested kind.
- isSampler
  
  public boolean isSampler()
  
  Is this AggregationContainer of a sampler kind?
- sampler
  
  public SamplerAggregation sampler()
  
  Get the sampler variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the sampler kind.
- isScriptedMetric
  
  public boolean isScriptedMetric()
  
  Is this AggregationContainer of a scripted_metric kind?
- scriptedMetric
  
  public ScriptedMetricAggregation scriptedMetric()
  
  Get the scripted_metric variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the scripted_metric kind.
- isSerialDiff
  
  public boolean isSerialDiff()
  
  Is this AggregationContainer of a serial_diff kind?
- serialDiff
  
  public SerialDifferencingAggregation serialDiff()
  
  Get the serial_diff variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the serial_diff kind.
- isSignificantTerms
  
  public boolean isSignificantTerms()
  
  Is this AggregationContainer of a significant_terms kind?
- significantTerms
  
  public SignificantTermsAggregation significantTerms()
  
  Get the significant_terms variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the significant_terms kind.
- isSignificantText
  
  public boolean isSignificantText()
  
  Is this AggregationContainer of a significant_text kind?
- significantText
  
  public SignificantTextAggregation significantText()
  
  Get the significant_text variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the significant_text kind.
- isStats
  
  public boolean isStats()
  
  Is this AggregationContainer of a stats kind?
- stats
  
  public jakarta.json.JsonValue stats()
  
  Get the stats variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the stats kind.
- isStatsBucket
  
  public boolean isStatsBucket()
  
  Is this AggregationContainer of a stats_bucket kind?
- statsBucket
  
  public jakarta.json.JsonValue statsBucket()
  
  Get the stats_bucket variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the stats_bucket kind.
- isStringStats
  
  public boolean isStringStats()
  
  Is this AggregationContainer of a string_stats kind?
- stringStats
  
  public StringStatsAggregation stringStats()
  
  Get the string_stats variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the string_stats kind.
- isSum
  
  public boolean isSum()
  
  Is this AggregationContainer of a sum kind?
- sum
  
  public jakarta.json.JsonValue sum()
  
  Get the sum variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the sum kind.
- isSumBucket
  
  public boolean isSumBucket()
  
  Is this AggregationContainer of a sum_bucket kind?
- sumBucket
  
  public jakarta.json.JsonValue sumBucket()
  
  Get the sum_bucket variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the sum_bucket kind.
- isTerms
  
  public boolean isTerms()
  
  Is this AggregationContainer of a terms kind?
- terms
  
  public TermsAggregation terms()
  
  Get the terms variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the terms kind.
- isTopHits
  
  public boolean isTopHits()
  
  Is this AggregationContainer of a top_hits kind?
- topHits
  
  public TopHitsAggregation topHits()
  
  Get the top_hits variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the top_hits kind.
- isTTest
  
  public boolean isTTest()
  
  Is this AggregationContainer of a t_test kind?
- tTest
  
  public TTestAggregation tTest()
  
  Get the t_test variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the t_test kind.
- isTopMetrics
  
  public boolean isTopMetrics()
  
  Is this AggregationContainer of a top_metrics kind?
- topMetrics
  
  public TopMetricsAggregation topMetrics()
  
  Get the top_metrics variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the top_metrics kind.
- isValueCount
  
  public boolean isValueCount()
  
  Is this AggregationContainer of a value_count kind?
- valueCount
  
  public jakarta.json.JsonValue valueCount()
  
  Get the value_count variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the value_count kind.
- isWeightedAvg
  
  public boolean isWeightedAvg()
  
  Is this AggregationContainer of a weighted_avg kind?
- weightedAvg
  
  public WeightedAverageAggregation weightedAvg()
  
  Get the weighted_avg variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the weighted_avg kind.
- isVariableWidthHistogram
  
  public boolean isVariableWidthHistogram()
  
  Is this AggregationContainer of a variable_width_histogram kind?
- variableWidthHistogram
  
  public VariableWidthHistogramAggregation variableWidthHistogram()
  
  Get the variable_width_histogram variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the variable_width_histogram kind.
- toJsonp
  
  public void toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
  
  Specified by:
  
  toJsonp in interface ToJsonp

Modifier and Type	Class	Description
`static class`	`AggregationContainer.Builder`
`static class`	`AggregationContainer.Tag`

Class AggregationContainer

Nested Class Summary

Field Summary

Fields inherited from class org.opensearch.client.util.TaggedUnion

Method Summary

Methods inherited from class org.opensearch.client.util.TaggedUnion

Methods inherited from class java.lang.Object

Field Details

Method Details