Package org.elasticsearch.client.rollup.job.config

Class MetricConfig

java.lang.Object
org.elasticsearch.client.rollup.job.config.MetricConfig
All Implemented Interfaces:
Validatable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class MetricConfig extends Object implements Validatable, org.elasticsearch.xcontent.ToXContentObject
The configuration object for the metrics portion of a rollup job config { "metrics": [ { "field": "foo", "metrics": [ "min", "max", "sum"] }, { "field": "bar", "metrics": [ "max" ] } ] }

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

  • Field Summary

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

    Fields inherited from interface org.elasticsearch.client.Validatable

    EMPTY

  • Constructor Summary

    Constructors
    Constructor
    Description
    MetricConfig(String field, List<String> metrics)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object other)
     
    static MetricConfig
    fromXContent(org.elasticsearch.xcontent.XContentParser parser)
     
    String
    getField()
     
    List<String>
    getMetrics()
     
    int
    hashCode()
     
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    Optional<ValidationException>
    validate()
    Perform validation.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment

  • Constructor Details

  • Method Details

    • validate

      public Optional<ValidationException> validate()
      Description copied from interface: Validatable
      Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. A ValidationException that is not null is assumed to contain validation errors and will be thrown.
      Specified by:
      validate in interface Validatable
      Returns:
      An Optional ValidationException that contains a list of validation errors.

    • getField

      public String getField()
      Returns:
      the name of the field used in the metric configuration. Never null.

    • getMetrics

      public List<String> getMetrics()
      Returns:
      the names of the metrics used in the metric configuration. Never null.

    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • fromXContent

      public static MetricConfig fromXContent(org.elasticsearch.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException