MetricAggregation (Jest Common Jar 2.4.0 API)

java.lang.Object
- io.searchbox.core.search.aggregation.Aggregation
- - io.searchbox.core.search.aggregation.MetricAggregation

Direct Known Subclasses:

Bucket, CardinalityAggregation, GeoBoundsAggregation, MissingAggregation, PercentileRanksAggregation, PercentilesAggregation, RootAggregation, SingleValueAggregation, StatsAggregation, ValueCountAggregation
```
public abstract class MetricAggregation
extends Aggregation
```
Author:

cfstout

Field Summary
- Fields inherited from class io.searchbox.core.search.aggregation.Aggregation
  jsonRoot, name

Constructor Summary

Constructors
Constructor and Description

MetricAggregation(String name, com.google.gson.JsonObject root)

Constructors
Constructor and Description
`MetricAggregation(String name, com.google.gson.JsonObject root)`

Method Summary

Methods
Modifier and Type	Method and Description
`<T extends Aggregation> T`	`getAggregation(String aggName, Class<T> aggType)`
`List<Aggregation>`	`getAggregations(Map<String,Class> nameToTypeMap)`
`AvgAggregation`	`getAvgAggregation(String aggName)`
`CardinalityAggregation`	`getCardinalityAggregation(String aggName)`
`DateHistogramAggregation`	`getDateHistogramAggregation(String aggName)`
`DateRangeAggregation`	`getDateRangeAggregation(String aggName)`
`ExtendedStatsAggregation`	`getExtendedStatsAggregation(String aggName)`
`FilterAggregation`	`getFilterAggregation(String aggName)`
`FiltersAggregation`	`getFiltersAggregation(String aggName)`
`GeoBoundsAggregation`	`getGeoBoundsAggregation(String aggName)`
`GeoDistanceAggregation`	`getGeoDistanceAggregation(String aggName)`
`GeoHashGridAggregation`	`getGeohashGridAggregation(String aggName)`
`HistogramAggregation`	`getHistogramAggregation(String aggName)`
`Ipv4RangeAggregation`	`getIpv4RangeAggregation(String aggName)`
`MaxAggregation`	`getMaxAggregation(String aggName)`
`MinAggregation`	`getMinAggregation(String aggName)`
`MissingAggregation`	`getMissingAggregation(String aggName)`
`PercentileRanksAggregation`	`getPercentileRanksAggregation(String aggName)`
`PercentilesAggregation`	`getPercentilesAggregation(String aggName)`
`RangeAggregation`	`getRangeAggregation(String aggName)`
`ScriptedMetricAggregation`	`getScriptedMetricAggregation(String aggName)`
`SignificantTermsAggregation`	`getSignificantTermsAggregation(String aggName)`
`StatsAggregation`	`getStatsAggregation(String aggName)`
`SumAggregation`	`getSumAggregation(String aggName)`
`TermsAggregation`	`getTermsAggregation(String aggName)`
`TopHitsAggregation`	`getTopHitsAggregation(String aggName)`
`ValueCountAggregation`	`getValueCountAggregation(String aggName)`

Methods inherited from class io.searchbox.core.search.aggregation.Aggregation
equals, getName, hashCode

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MetricAggregation
```
public MetricAggregation(String name,
                 com.google.gson.JsonObject root)
```
- Method Detail
  - getAggregations
```
public List<Aggregation> getAggregations(Map<String,Class> nameToTypeMap)
```
    Parameters:
    nameToTypeMap - a map of aggNames to their expected type (extension of Aggregation class)
    
    Returns:
    A list of aggregation objects for the provided name:type pairs if the name can be found in the root json object
    
    Throws:
    
    RuntimeException - if no constructor found for an expected type in the map
  - getAggregation
```
public <T extends Aggregation> T getAggregation(String aggName,
                                       Class<T> aggType)
```
    Parameters:
    aggName - Name of the desired aggregation
    aggType - Extension of Aggregation class expected as return type
    
    Returns:
    Aggregation of type T if aggName can be found in aggregation json or null otherwise
    
    Throws:
    
    RuntimeException - if no constructor exists for provided aggType
  - getAvgAggregation
```
public AvgAggregation getAvgAggregation(String aggName)
```
    Parameters:
    aggName - Name of the AvgAggregation
    
    Returns:
    a new AvgAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getCardinalityAggregation
```
public CardinalityAggregation getCardinalityAggregation(String aggName)
```
    Parameters:
    aggName - Name of the CardinalityAggregation
    
    Returns:
    a new CardinalityAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getDateHistogramAggregation
```
public DateHistogramAggregation getDateHistogramAggregation(String aggName)
```
    Parameters:
    aggName - Name of the DateHistogramAggregation
    
    Returns:
    a new DateHistogramAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getDateRangeAggregation
```
public DateRangeAggregation getDateRangeAggregation(String aggName)
```
    Parameters:
    aggName - Name of the DateRangeAggregation
    
    Returns:
    a new DateRangeAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getExtendedStatsAggregation
```
public ExtendedStatsAggregation getExtendedStatsAggregation(String aggName)
```
    Parameters:
    aggName - Name of the ExtendedStatsAggregation
    
    Returns:
    a new ExtendedStatsAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getFilterAggregation
```
public FilterAggregation getFilterAggregation(String aggName)
```
    Parameters:
    aggName - Name of the FilterAggregation
    
    Returns:
    a new FilterAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getFiltersAggregation
```
public FiltersAggregation getFiltersAggregation(String aggName)
```
    Parameters:
    aggName - Name of the FiltersAggregation
    
    Returns:
    a new FiltersAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getGeoBoundsAggregation
```
public GeoBoundsAggregation getGeoBoundsAggregation(String aggName)
```
    Parameters:
    aggName - Name of the GeoBoundsAggregation
    
    Returns:
    a new GeoBoundsAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getGeoDistanceAggregation
```
public GeoDistanceAggregation getGeoDistanceAggregation(String aggName)
```
    Parameters:
    aggName - Name of the GeoDistanceAggregation
    
    Returns:
    a new GeoDistanceAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getGeohashGridAggregation
```
public GeoHashGridAggregation getGeohashGridAggregation(String aggName)
```
    Parameters:
    aggName - Name of the GeohashGridAggregation
    
    Returns:
    a new GeohashGridAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getHistogramAggregation
```
public HistogramAggregation getHistogramAggregation(String aggName)
```
    Parameters:
    aggName - Name of the HistogramAggregation
    
    Returns:
    a new HistogramAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getIpv4RangeAggregation
```
public Ipv4RangeAggregation getIpv4RangeAggregation(String aggName)
```
    Parameters:
    aggName - Name of the Ipv4RangeAggregation
    
    Returns:
    a new Ipv4RangeAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getMaxAggregation
```
public MaxAggregation getMaxAggregation(String aggName)
```
    Parameters:
    aggName - Name of the MaxAggregation
    
    Returns:
    a new MaxAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getMinAggregation
```
public MinAggregation getMinAggregation(String aggName)
```
    Parameters:
    aggName - Name of the MinAggregation
    
    Returns:
    a new MinAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getMissingAggregation
```
public MissingAggregation getMissingAggregation(String aggName)
```
    Parameters:
    aggName - Name of the MissingAggregation
    
    Returns:
    a new MissingAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getPercentileRanksAggregation
```
public PercentileRanksAggregation getPercentileRanksAggregation(String aggName)
```
    Parameters:
    aggName - Name of the PercentileRanksAggregation
    
    Returns:
    a new PercentileRanksAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getPercentilesAggregation
```
public PercentilesAggregation getPercentilesAggregation(String aggName)
```
    Parameters:
    aggName - Name of the PercentilesAggregation
    
    Returns:
    a new PercentilesAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getRangeAggregation
```
public RangeAggregation getRangeAggregation(String aggName)
```
    Parameters:
    aggName - Name of the RangeAggregation
    
    Returns:
    a new RangeAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getScriptedMetricAggregation
```
public ScriptedMetricAggregation getScriptedMetricAggregation(String aggName)
```
    Parameters:
    aggName - Name of the ScriptedMetricAggregation
    
    Returns:
    a new ScriptedMetricAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getSignificantTermsAggregation
```
public SignificantTermsAggregation getSignificantTermsAggregation(String aggName)
```
    Parameters:
    aggName - Name of the SignificantTermsAggregation
    
    Returns:
    a new SignificantTermsAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getStatsAggregation
```
public StatsAggregation getStatsAggregation(String aggName)
```
    Parameters:
    aggName - Name of the StatsAggregation
    
    Returns:
    a new StatsAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getSumAggregation
```
public SumAggregation getSumAggregation(String aggName)
```
    Parameters:
    aggName - Name of the SumAggregation
    
    Returns:
    a new SumAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getTermsAggregation
```
public TermsAggregation getTermsAggregation(String aggName)
```
    Parameters:
    aggName - Name of the TermsAggregation
    
    Returns:
    a new TermsAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getValueCountAggregation
```
public ValueCountAggregation getValueCountAggregation(String aggName)
```
    Parameters:
    aggName - Name of the ValueCountAggregation
    
    Returns:
    a new ValueCountAggregation object if aggName is found within sub-aggregations of current aggregation level or null if not found
  - getTopHitsAggregation
```
public TopHitsAggregation getTopHitsAggregation(String aggName)
```

Class MetricAggregation

Field Summary

Fields inherited from class io.searchbox.core.search.aggregation.Aggregation

Constructor Summary

Method Summary

Methods inherited from class io.searchbox.core.search.aggregation.Aggregation

Methods inherited from class java.lang.Object

Constructor Detail

MetricAggregation

Method Detail

getAggregations

getAggregation

getAvgAggregation

getCardinalityAggregation

getDateHistogramAggregation

getDateRangeAggregation

getExtendedStatsAggregation

getFilterAggregation

getFiltersAggregation

getGeoBoundsAggregation

getGeoDistanceAggregation

getGeohashGridAggregation

getHistogramAggregation

getIpv4RangeAggregation

getMaxAggregation

getMinAggregation

getMissingAggregation

getPercentileRanksAggregation

getPercentilesAggregation

getRangeAggregation

getScriptedMetricAggregation

getSignificantTermsAggregation

getStatsAggregation

getSumAggregation

getTermsAggregation

getValueCountAggregation

getTopHitsAggregation