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

Class MetricConfig

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

  • Constructor Details

    • MetricConfig

      public MetricConfig​(java.lang.String field, java.util.List<java.lang.String> metrics)

  • Method Details

    • validate

      public java.util.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 java.lang.String getField()
      Returns:
      the name of the field used in the metric configuration. Never null.

    • getMetrics

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

    • toXContent

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

    • equals

      public boolean equals​(java.lang.Object other)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • fromXContent

      public static MetricConfig fromXContent​(XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException