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

Class AnalysisConfig

  • All Implemented Interfaces:
    ToXContent, ToXContentObject
    public class AnalysisConfig
extends 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 take null values.

    • Method Detail

      • getBucketSpan

        public TimeValue getBucketSpan()
        The analysis bucket span
        Returns:
        The bucketspan or null if not set

      • getCategorizationFieldName

        public String getCategorizationFieldName()

      • getCategorizationFilters

        public List<String> getCategorizationFilters()

      • 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 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 List<Detector> getDetectors()
        The list of analysis detectors. In a valid configuration the list should contain at least 1 Detector
        Returns:
        The Detectors used in this job

      • getInfluencers

        public List<String> getInfluencers()
        The list of influence field names

      • getMultivariateByFields

        public Boolean getMultivariateByFields()

      • partitionFields

        public List<String> partitionFields()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object