Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.rollup.job

Class MetricConfig

java.lang.Object

org.elasticsearch.xpack.core.rollup.job.MetricConfig

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class MetricConfig
extends Object
implements Writeable, 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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	AVG
static final ParseField	MAX
static final ParseField	MIN
static final String	NAME
static final ParseField	SUM
static final ParseField	VALUE_COUNT

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
static MetricConfig	fromXContent(XContentParser parser)
String	getField()
List<String>	getMetrics()
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	validateMappings(Map<String,Map<String,FieldCapabilities>> fieldCapsResponse, ActionRequestValidationException validationException)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

MIN

public static final ParseField MIN

MAX

public static final ParseField MAX

SUM

public static final ParseField SUM

AVG

public static final ParseField AVG

VALUE_COUNT

public static final ParseField VALUE_COUNT

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

MetricConfig

public MetricConfig(String field,
 List<String> metrics)

MetricConfig

public MetricConfig(StreamInput in)
             throws IOException

Throws:

IOException

Method Details

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.

validateMappings

public void validateMappings(Map<String,Map<String,FieldCapabilities>> fieldCapsResponse,
 ActionRequestValidationException validationException)

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

fromXContent

public static MetricConfig fromXContent(XContentParser parser)
                                 throws IOException

Throws:

IOException