Class AnalysisConfig
java.lang.Object
org.elasticsearch.client.ml.job.config.AnalysisConfig
- All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.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/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
-
Field Summary
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseField
Serialisation namesstatic final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ConstructingObjectParser<AnalysisConfig.Builder,
Void> static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Method Summary
Modifier and TypeMethodDescriptionstatic AnalysisConfig.Builder
byFields()
boolean
fields()
org.elasticsearch.core.TimeValue
The analysis bucket spanThe list of analysis detectors.The list of influence field namesorg.elasticsearch.core.TimeValue
The latency interval during which out-of-order records should be handled.org.elasticsearch.core.TimeValue
The name of the field that contains counts for pre-summarised inputint
hashCode()
org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.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.xcontent.ToXContentObject
isFragment
-
Field Details
-
ANALYSIS_CONFIG
public static final org.elasticsearch.xcontent.ParseField ANALYSIS_CONFIGSerialisation names -
BUCKET_SPAN
public static final org.elasticsearch.xcontent.ParseField BUCKET_SPAN -
CATEGORIZATION_FIELD_NAME
public static final org.elasticsearch.xcontent.ParseField CATEGORIZATION_FIELD_NAME -
CATEGORIZATION_FILTERS
public static final org.elasticsearch.xcontent.ParseField CATEGORIZATION_FILTERS -
CATEGORIZATION_ANALYZER
public static final org.elasticsearch.xcontent.ParseField CATEGORIZATION_ANALYZER -
PER_PARTITION_CATEGORIZATION
public static final org.elasticsearch.xcontent.ParseField PER_PARTITION_CATEGORIZATION -
LATENCY
public static final org.elasticsearch.xcontent.ParseField LATENCY -
SUMMARY_COUNT_FIELD_NAME
public static final org.elasticsearch.xcontent.ParseField SUMMARY_COUNT_FIELD_NAME -
DETECTORS
public static final org.elasticsearch.xcontent.ParseField DETECTORS -
INFLUENCERS
public static final org.elasticsearch.xcontent.ParseField INFLUENCERS -
MULTIVARIATE_BY_FIELDS
public static final org.elasticsearch.xcontent.ParseField MULTIVARIATE_BY_FIELDS -
MODEL_PRUNE_WINDOW
public static final org.elasticsearch.xcontent.ParseField MODEL_PRUNE_WINDOW -
PARSER
public static final org.elasticsearch.xcontent.ConstructingObjectParser<AnalysisConfig.Builder,Void> PARSER
-
-
Method Details
-
getBucketSpan
public org.elasticsearch.core.TimeValue getBucketSpan()The analysis bucket span- Returns:
- The bucketspan or
null
if not set
-
getCategorizationFieldName
-
getCategorizationFilters
-
getCategorizationAnalyzerConfig
-
getPerPartitionCategorizationConfig
-
getLatency
public org.elasticsearch.core.TimeValue getLatency()The latency interval during which out-of-order records should be handled.- Returns:
- The latency interval or
null
if not set
-
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
The list of influence field names -
getMultivariateByFields
-
getModelPruneWindow
public org.elasticsearch.core.TimeValue getModelPruneWindow() -
fields
-
byFields
-
overFields
-
partitionFields
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
equals
-
hashCode
public int hashCode() -
builder
-