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" ] } ] }
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
-
Field Summary
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
-
Constructor Summary
Constructors Constructor Description MetricConfig(java.lang.String field, java.util.List<java.lang.String> metrics)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object other)
static MetricConfig
fromXContent(XContentParser parser)
java.lang.String
getField()
java.util.List<java.lang.String>
getMetrics()
int
hashCode()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
java.util.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.common.xcontent.ToXContentObject
isFragment
-
-
-
-
Method Detail
-
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. AValidationException
that is not null is assumed to contain validation errors and will be thrown.- Specified by:
validate
in interfaceValidatable
- 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 interfaceToXContent
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
fromXContent
public static MetricConfig fromXContent(XContentParser parser) throws java.io.IOException
- Throws:
java.io.IOException
-
-