Package org.elasticsearch.search.aggregations.pipeline

Enum Class BucketHelpers.GapPolicy

<BucketHelpers.GapPolicy>
org.elasticsearch.search.aggregations.pipeline.BucketHelpers.GapPolicy
All Implemented Interfaces:
, <, Writeable
Enclosing class:
BucketHelpers
public static enum BucketHelpers.GapPolicy extends <BucketHelpers.GapPolicy> implements Writeable
A gap policy determines how "holes" in a set of buckets should be handled. For example, a date_histogram might have empty buckets due to no data existing for that time interval. This can cause problems for operations like a derivative, which relies on a continuous function. "insert_zeros": empty buckets will be filled with zeros for all metrics "skip": empty buckets will simply be ignored "keep_values": for empty buckets the values provided by the metrics will still be used if they are available

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.

    < extends <>>

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    INSERT_ZEROS
     
    KEEP_VALUES
     
    SKIP
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    boolean
    isSkippable
     

  • Method Summary

    Modifier and Type
    Method
    Description
    getName()
    Return the english-formatted name of the GapPolicy
    static BucketHelpers.GapPolicy
     text, org.elasticsearch.common.xcontent.XContentLocation tokenLocation)
    Parse a string GapPolicy into the byte enum
    abstract
    processValue​(long docCount,  value)
     
    static BucketHelpers.GapPolicy
    readFrom​(StreamInput in)
    Deserialize the GapPolicy from the input stream
    static BucketHelpers.GapPolicy
     name)
    Returns the enum constant of this class with the specified name.
    static BucketHelpers.GapPolicy[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    void
    writeTo​(StreamOutput out)
    Serialize the GapPolicy to the output stream

    Methods inherited from class java.lang.

    , , , , , , , , , ,

    Methods inherited from class java.lang.

    , , , , ,

  • Enum Constant Details

  • Field Details

    • isSkippable

      public final boolean isSkippable

  • Method Details

    • values

      public static BucketHelpers.GapPolicy[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static  name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      - if this enum class has no constant with the specified name
      - if the argument is null

    • parse

      public static  text, org.elasticsearch.common.xcontent.XContentLocation tokenLocation)
      Parse a string GapPolicy into the byte enum
      Parameters:
      text - GapPolicy in string format (e.g. "ignore")
      Returns:
      GapPolicy enum

    • writeTo

      public void writeTo​(StreamOutput out) throws
      Serialize the GapPolicy to the output stream
      Specified by:
      writeTo in interface Writeable
      Throws:

    • readFrom

      public static BucketHelpers.GapPolicy readFrom​(StreamInput in) throws
      Deserialize the GapPolicy from the input stream
      Returns:
      GapPolicy Enum
      Throws:

    • getName

      public  getName()
      Return the english-formatted name of the GapPolicy
      Returns:
      English representation of GapPolicy

    • processValue

      public abstract  processValue​(long docCount,  value)