Class Detector
- java.lang.Object
-
- org.elasticsearch.client.ml.job.config.Detector
-
- All Implemented Interfaces:
ToXContent
,ToXContentObject
public class Detector extends java.lang.Object implements ToXContentObject
Defines the fields and functions used in the analysis. A combination offield_name
,by_field_name
andover_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,java.lang.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(java.lang.Object other)
java.lang.String
getByFieldName()
The 'by' field ornull
if not set.java.lang.String
getDetectorDescription()
int
getDetectorIndex()
Detector.ExcludeFrequent
getExcludeFrequent()
Excludes frequently-occurring metrics from the analysis; can apply to 'by' field, 'over' field, or bothjava.lang.String
getFieldName()
The Analysis fieldDetectorFunction
getFunction()
The analysis function used e.g.java.lang.String
getOverFieldName()
The 'over' field ornull
if not set.java.lang.String
getPartitionFieldName()
Segments the analysis along another field to have completely independent baselines for each instance of partitionfieldjava.util.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,java.lang.Void> PARSER
-
-
Method Detail
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
getDetectorDescription
public java.lang.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 java.lang.String getFieldName()
The Analysis field- Returns:
- The field to analyse
-
getByFieldName
public java.lang.String getByFieldName()
The 'by' field ornull
if not set.- Returns:
- The 'by' field
-
getOverFieldName
public java.lang.String getOverFieldName()
The 'over' field ornull
if not set.- Returns:
- The 'over' field
-
getPartitionFieldName
public java.lang.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 java.util.List<DetectionRule> getRules()
-
getDetectorIndex
public int getDetectorIndex()
- Returns:
- the detector index or a negative number if unknown
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
builder
public static Detector.Builder builder()
-
-