Class AnalysisConfig
- java.lang.Object
-
- org.elasticsearch.client.ml.job.config.AnalysisConfig
-
- All Implemented Interfaces:
ToXContent
,ToXContentObject
public class AnalysisConfig extends java.lang.Object implements ToXContentObject
Analysis configuration options that describe which fields are analyzed and which functions are used to detect anomalies.The configuration can contain multiple detectors, a new anomaly detector will be created for each detector configuration. The fields
bucketSpan, summaryCountFieldName and categorizationFieldName
apply to all detectors.If a value has not been set it will be
null
Object wrappers are used around integral types & booleans so they can takenull
values.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AnalysisConfig.Builder
-
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
ANALYSIS_CONFIG
Serialisation namesstatic ParseField
BUCKET_SPAN
static ParseField
CATEGORIZATION_ANALYZER
static ParseField
CATEGORIZATION_FIELD_NAME
static ParseField
CATEGORIZATION_FILTERS
static ParseField
DETECTORS
static ParseField
INFLUENCERS
static ParseField
LATENCY
static ParseField
MULTIVARIATE_BY_FIELDS
static ConstructingObjectParser<AnalysisConfig.Builder,java.lang.Void>
PARSER
static ParseField
SUMMARY_COUNT_FIELD_NAME
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Method Summary
Modifier and Type Method Description static AnalysisConfig.Builder
builder(java.util.List<Detector> detectors)
java.util.List<java.lang.String>
byFields()
boolean
equals(java.lang.Object object)
java.util.List<java.lang.String>
fields()
TimeValue
getBucketSpan()
The analysis bucket spanCategorizationAnalyzerConfig
getCategorizationAnalyzerConfig()
java.lang.String
getCategorizationFieldName()
java.util.List<java.lang.String>
getCategorizationFilters()
java.util.List<Detector>
getDetectors()
The list of analysis detectors.java.util.List<java.lang.String>
getInfluencers()
The list of influence field namesTimeValue
getLatency()
The latency interval during which out-of-order records should be handled.java.lang.Boolean
getMultivariateByFields()
java.lang.String
getSummaryCountFieldName()
The name of the field that contains counts for pre-summarised inputint
hashCode()
java.util.List<java.lang.String>
overFields()
java.util.List<java.lang.String>
partitionFields()
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
-
ANALYSIS_CONFIG
public static final ParseField ANALYSIS_CONFIG
Serialisation names
-
BUCKET_SPAN
public static final ParseField BUCKET_SPAN
-
CATEGORIZATION_FIELD_NAME
public static final ParseField CATEGORIZATION_FIELD_NAME
-
CATEGORIZATION_FILTERS
public static final ParseField CATEGORIZATION_FILTERS
-
CATEGORIZATION_ANALYZER
public static final ParseField CATEGORIZATION_ANALYZER
-
LATENCY
public static final ParseField LATENCY
-
SUMMARY_COUNT_FIELD_NAME
public static final ParseField SUMMARY_COUNT_FIELD_NAME
-
DETECTORS
public static final ParseField DETECTORS
-
INFLUENCERS
public static final ParseField INFLUENCERS
-
MULTIVARIATE_BY_FIELDS
public static final ParseField MULTIVARIATE_BY_FIELDS
-
PARSER
public static final ConstructingObjectParser<AnalysisConfig.Builder,java.lang.Void> PARSER
-
-
Method Detail
-
getBucketSpan
public TimeValue getBucketSpan()
The analysis bucket span- Returns:
- The bucketspan or
null
if not set
-
getCategorizationFieldName
public java.lang.String getCategorizationFieldName()
-
getCategorizationFilters
public java.util.List<java.lang.String> getCategorizationFilters()
-
getCategorizationAnalyzerConfig
public CategorizationAnalyzerConfig getCategorizationAnalyzerConfig()
-
getLatency
public TimeValue getLatency()
The latency interval during which out-of-order records should be handled.- Returns:
- The latency interval or
null
if not set
-
getSummaryCountFieldName
public java.lang.String getSummaryCountFieldName()
The name of the field that contains counts for pre-summarised input- Returns:
- The field name or
null
if not set
-
getDetectors
public java.util.List<Detector> getDetectors()
The list of analysis detectors. In a valid configuration the list should contain at least 1Detector
- Returns:
- The Detectors used in this job
-
getInfluencers
public java.util.List<java.lang.String> getInfluencers()
The list of influence field names
-
getMultivariateByFields
public java.lang.Boolean getMultivariateByFields()
-
fields
public java.util.List<java.lang.String> fields()
-
byFields
public java.util.List<java.lang.String> byFields()
-
overFields
public java.util.List<java.lang.String> overFields()
-
partitionFields
public java.util.List<java.lang.String> partitionFields()
-
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 object)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
builder
public static AnalysisConfig.Builder builder(java.util.List<Detector> detectors)
-
-