Class BucketMetricsParser

java.lang.Object
org.elasticsearch.search.aggregations.pipeline.BucketMetricsParser
All Implemented Interfaces:
PipelineAggregator.Parser
Direct Known Subclasses:
ExtendedStatsBucketParser

public abstract class BucketMetricsParser
extends java.lang.Object
implements PipelineAggregator.Parser
A parser for parsing requests for a BucketMetricsPipelineAggregator
  • Field Summary

    Fields
    Modifier and Type Field Description
    static org.elasticsearch.common.ParseField FORMAT  

    Fields inherited from interface org.elasticsearch.search.aggregations.pipeline.PipelineAggregator.Parser

    BUCKETS_PATH, GAP_POLICY
  • Constructor Summary

    Constructors
    Constructor Description
    BucketMetricsParser()  
  • Method Summary

    Modifier and Type Method Description
    protected abstract BucketMetricsPipelineAggregationBuilder<?> buildFactory​(java.lang.String pipelineAggregatorName, java.lang.String bucketsPaths, java.util.Map<java.lang.String,​java.lang.Object> params)  
    BucketMetricsPipelineAggregationBuilder<?> parse​(java.lang.String pipelineAggregatorName, org.elasticsearch.common.xcontent.XContentParser parser)
    Returns the pipeline aggregator factory with which this parser is associated.
    protected boolean token​(org.elasticsearch.common.xcontent.XContentParser parser, java.lang.String field, org.elasticsearch.common.xcontent.XContentParser.Token token, java.util.Map<java.lang.String,​java.lang.Object> params)  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • FORMAT

      public static final org.elasticsearch.common.ParseField FORMAT
  • Constructor Details

    • BucketMetricsParser

      public BucketMetricsParser()
  • Method Details

    • parse

      public final BucketMetricsPipelineAggregationBuilder<?> parse​(java.lang.String pipelineAggregatorName, org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Description copied from interface: PipelineAggregator.Parser
      Returns the pipeline aggregator factory with which this parser is associated.
      Specified by:
      parse in interface PipelineAggregator.Parser
      Parameters:
      pipelineAggregatorName - The name of the pipeline aggregation
      parser - the parser
      Returns:
      The resolved pipeline aggregator factory
      Throws:
      java.io.IOException - When parsing fails
    • buildFactory

      protected abstract BucketMetricsPipelineAggregationBuilder<?> buildFactory​(java.lang.String pipelineAggregatorName, java.lang.String bucketsPaths, java.util.Map<java.lang.String,​java.lang.Object> params)
    • token

      protected boolean token​(org.elasticsearch.common.xcontent.XContentParser parser, java.lang.String field, org.elasticsearch.common.xcontent.XContentParser.Token token, java.util.Map<java.lang.String,​java.lang.Object> params) throws java.io.IOException
      Throws:
      java.io.IOException