Class AnalysisConfig
java.lang.Object
org.elasticsearch.client.ml.job.config.AnalysisConfig
- All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class AnalysisConfig
extends java.lang.Object
implements org.elasticsearch.common.xcontent.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 take
null
values.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AnalysisConfig.Builder
-
Field Summary
Fields Modifier and Type Field Description static org.elasticsearch.common.ParseField
ANALYSIS_CONFIG
Serialisation namesstatic org.elasticsearch.common.ParseField
BUCKET_SPAN
static org.elasticsearch.common.ParseField
CATEGORIZATION_ANALYZER
static org.elasticsearch.common.ParseField
CATEGORIZATION_FIELD_NAME
static org.elasticsearch.common.ParseField
CATEGORIZATION_FILTERS
static org.elasticsearch.common.ParseField
DETECTORS
static org.elasticsearch.common.ParseField
INFLUENCERS
static org.elasticsearch.common.ParseField
LATENCY
static org.elasticsearch.common.ParseField
MULTIVARIATE_BY_FIELDS
static org.elasticsearch.common.xcontent.ConstructingObjectParser<AnalysisConfig.Builder,java.lang.Void>
PARSER
static org.elasticsearch.common.ParseField
PER_PARTITION_CATEGORIZATION
static org.elasticsearch.common.ParseField
SUMMARY_COUNT_FIELD_NAME
-
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()
org.elasticsearch.common.unit.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 namesorg.elasticsearch.common.unit.TimeValue
getLatency()
The latency interval during which out-of-order records should be handled.java.lang.Boolean
getMultivariateByFields()
PerPartitionCategorizationConfig
getPerPartitionCategorizationConfig()
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()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
-
Field Details
-
ANALYSIS_CONFIG
public static final org.elasticsearch.common.ParseField ANALYSIS_CONFIGSerialisation names -
BUCKET_SPAN
public static final org.elasticsearch.common.ParseField BUCKET_SPAN -
CATEGORIZATION_FIELD_NAME
public static final org.elasticsearch.common.ParseField CATEGORIZATION_FIELD_NAME -
CATEGORIZATION_FILTERS
public static final org.elasticsearch.common.ParseField CATEGORIZATION_FILTERS -
CATEGORIZATION_ANALYZER
public static final org.elasticsearch.common.ParseField CATEGORIZATION_ANALYZER -
PER_PARTITION_CATEGORIZATION
public static final org.elasticsearch.common.ParseField PER_PARTITION_CATEGORIZATION -
LATENCY
public static final org.elasticsearch.common.ParseField LATENCY -
SUMMARY_COUNT_FIELD_NAME
public static final org.elasticsearch.common.ParseField SUMMARY_COUNT_FIELD_NAME -
DETECTORS
public static final org.elasticsearch.common.ParseField DETECTORS -
INFLUENCERS
public static final org.elasticsearch.common.ParseField INFLUENCERS -
MULTIVARIATE_BY_FIELDS
public static final org.elasticsearch.common.ParseField MULTIVARIATE_BY_FIELDS -
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<AnalysisConfig.Builder,java.lang.Void> PARSER
-
-
Method Details
-
getBucketSpan
public org.elasticsearch.common.unit.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
-
getPerPartitionCategorizationConfig
-
getLatency
public org.elasticsearch.common.unit.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
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 org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- 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
-