Package org.elasticsearch.client.ml.job.config

Class Detector

java.lang.Object

org.elasticsearch.client.ml.job.config.Detector

All Implemented Interfaces:

ToXContent, ToXContentObject

public class Detector
extends Object
implements ToXContentObject

Defines the fields and functions used in the analysis. A combination of field_name, by_field_name and over_field_name can be used depending on the specific function chosen. For more information see configuring detectors and detector functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Detector.Builder
static class	Detector.ExcludeFrequent

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	BY_FIELD_NAME_FIELD
static ParseField	CUSTOM_RULES_FIELD
static ParseField	DETECTOR_DESCRIPTION_FIELD
static ParseField	DETECTOR_INDEX
static ParseField	EXCLUDE_FREQUENT_FIELD
static ParseField	FIELD_NAME_FIELD
static ParseField	FUNCTION_FIELD
static ParseField	OVER_FIELD_NAME_FIELD
static ObjectParser<Detector.Builder,Void>	PARSER
static ParseField	PARTITION_FIELD_NAME_FIELD
static ParseField	USE_NULL_FIELD

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
static Detector.Builder	builder()
boolean	equals(Object other)
String	getByFieldName()	The 'by' field or null if not set.
String	getDetectorDescription()
int	getDetectorIndex()
Detector.ExcludeFrequent	getExcludeFrequent()	Excludes frequently-occurring metrics from the analysis; can apply to 'by' field, 'over' field, or both
String	getFieldName()	The Analysis field
DetectorFunction	getFunction()	The analysis function used e.g.
String	getOverFieldName()	The 'over' field or null if not set.
String	getPartitionFieldName()	Segments the analysis along another field to have completely independent baselines for each instance of partitionfield
List<DetectionRule>	getRules()
int	hashCode()
boolean	isUseNull()	Where there isn't a value for the 'by' or 'over' field should a new series be used as the 'null' series.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

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

Field Detail

DETECTOR_DESCRIPTION_FIELD

public static final ParseField DETECTOR_DESCRIPTION_FIELD

FUNCTION_FIELD

public static final ParseField FUNCTION_FIELD

FIELD_NAME_FIELD

public static final ParseField FIELD_NAME_FIELD

BY_FIELD_NAME_FIELD

public static final ParseField BY_FIELD_NAME_FIELD

OVER_FIELD_NAME_FIELD

public static final ParseField OVER_FIELD_NAME_FIELD

PARTITION_FIELD_NAME_FIELD

public static final ParseField PARTITION_FIELD_NAME_FIELD

USE_NULL_FIELD

public static final ParseField USE_NULL_FIELD

EXCLUDE_FREQUENT_FIELD

public static final ParseField EXCLUDE_FREQUENT_FIELD

CUSTOM_RULES_FIELD

public static final ParseField CUSTOM_RULES_FIELD

DETECTOR_INDEX

public static final ParseField DETECTOR_INDEX

PARSER

public static final ObjectParser<Detector.Builder,Void> PARSER

Method Detail

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getDetectorDescription

public String getDetectorDescription()

getFunction

public DetectorFunction getFunction()

The analysis function used e.g. count, rare, min etc.

Returns:

The function or null if not set

getFieldName

public String getFieldName()

The Analysis field

Returns:

The field to analyse

getByFieldName

public String getByFieldName()

The 'by' field or null if not set.

Returns:

The 'by' field

getOverFieldName

public String getOverFieldName()

The 'over' field or null if not set.

Returns:

The 'over' field

getPartitionFieldName

public String getPartitionFieldName()

Segments the analysis along another field to have completely independent baselines for each instance of partitionfield

Returns:

The Partition Field

isUseNull

public boolean isUseNull()

Where there isn't a value for the 'by' or 'over' field should a new series be used as the 'null' series.

Returns:

true if the 'null' series should be created

getExcludeFrequent

public Detector.ExcludeFrequent getExcludeFrequent()

Excludes frequently-occurring metrics from the analysis; can apply to 'by' field, 'over' field, or both

Returns:

the value that the user set

getRules

public List<DetectionRule> getRules()

getDetectorIndex

public int getDetectorIndex()

Returns:

the detector index or a negative number if unknown

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static Detector.Builder builder()