Package org.opensearch.search.aggregations

Class ParsedAggregation

java.lang.Object
org.opensearch.search.aggregations.ParsedAggregation
All Implemented Interfaces:
org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment, Aggregation
Direct Known Subclasses:
ParsedCardinality, ParsedGeoBounds, ParsedGeoCentroid, ParsedMultiBucketAggregation, ParsedPercentiles, ParsedScriptedMetric, ParsedSingleBucketAggregation, ParsedSingleValueNumericMetricsAggregation, ParsedStats, ParsedTopHits, ParsedValueCount
public abstract class ParsedAggregation
extends java.lang.Object
implements Aggregation, org.opensearch.common.xcontent.ToXContentFragment
An implementation of Aggregation that is parsed from a REST response. Serves as a base class for all aggregation implementations that are parsed from REST.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.Aggregation

    Aggregation.CommonFields

    Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

    org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected java.util.Map<java.lang.String,​java.lang.Object> metadata  

    Fields inherited from interface org.opensearch.search.aggregations.Aggregation

    TYPED_KEYS_DELIMITER

    Fields inherited from interface org.opensearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors 
    Constructor Description
    ParsedAggregation()  

  • Method Summary

    Modifier and Type Method Description
    protected static void declareAggregationFields​(org.opensearch.common.xcontent.AbstractObjectParser<? extends ParsedAggregation,​?> objectParser)  
    protected abstract org.opensearch.common.xcontent.XContentBuilder doXContentBody​(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)  
    java.util.Map<java.lang.String,​java.lang.Object> getMetadata()
    Get the optional byte array metadata that was set on the aggregation
    java.lang.String getName()  
    protected static double parseDouble​(org.opensearch.common.xcontent.XContentParser parser, double defaultNullValue)
    Parse a token of type XContentParser.Token.VALUE_NUMBER or XContentParser.Token.STRING to a double.
    protected void setName​(java.lang.String name)  
    org.opensearch.common.xcontent.XContentBuilder toXContent​(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)  

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.search.aggregations.Aggregation

    getType

    Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

    isFragment

  • Field Details

    • metadata

      protected java.util.Map<java.lang.String,​java.lang.Object> metadata

  • Constructor Details

  • Method Details

    • declareAggregationFields

      protected static void declareAggregationFields​(org.opensearch.common.xcontent.AbstractObjectParser<? extends ParsedAggregation,​?> objectParser)

    • getName

      public final java.lang.String getName()
      Specified by:
      getName in interface Aggregation
      Returns:
      The name of this aggregation.

    • setName

      protected void setName​(java.lang.String name)

    • getMetadata

      public final java.util.Map<java.lang.String,​java.lang.Object> getMetadata()
      Description copied from interface: Aggregation
      Get the optional byte array metadata that was set on the aggregation
      Specified by:
      getMetadata in interface Aggregation

    • toXContent

      public org.opensearch.common.xcontent.XContentBuilder toXContent​(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.opensearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • doXContentBody

      protected abstract org.opensearch.common.xcontent.XContentBuilder doXContentBody​(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseDouble

      protected static double parseDouble​(org.opensearch.common.xcontent.XContentParser parser, double defaultNullValue) throws java.io.IOException
      Parse a token of type XContentParser.Token.VALUE_NUMBER or XContentParser.Token.STRING to a double. In other cases the default value is returned instead.
      Throws:
      java.io.IOException