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

Class AnalysisLimits

java.lang.Object
org.elasticsearch.client.ml.job.config.AnalysisLimits
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class AnalysisLimits extends Object implements org.elasticsearch.common.xcontent.ToXContentObject
Analysis limits for autodetect. In particular, this is a collection of parameters that allow limiting the resources used by the job.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static org.elasticsearch.common.xcontent.ParseField
    CATEGORIZATION_EXAMPLES_LIMIT
     
    static org.elasticsearch.common.xcontent.ParseField
    MODEL_MEMORY_LIMIT
    Serialisation field names
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<AnalysisLimits,​Void>
    PARSER
     

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    AnalysisLimits​(Long categorizationExamplesLimit)
     
    AnalysisLimits​(Long modelMemoryLimit, Long categorizationExamplesLimit)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object other)
    Overridden equality test
    Long
    getCategorizationExamplesLimit()
    Gets the limit to the number of examples that are stored per category
    Long
    getModelMemoryLimit()
    Maximum size of the model in MB before the anomaly detector will drop new samples to prevent the model using any more memory.
    int
    hashCode()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.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.common.xcontent.ToXContentObject

    isFragment

  • Field Details

    • MODEL_MEMORY_LIMIT

      public static final org.elasticsearch.common.xcontent.ParseField MODEL_MEMORY_LIMIT
      Serialisation field names

    • CATEGORIZATION_EXAMPLES_LIMIT

      public static final org.elasticsearch.common.xcontent.ParseField CATEGORIZATION_EXAMPLES_LIMIT

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<AnalysisLimits,​Void> PARSER

  • Constructor Details

    • AnalysisLimits

      public AnalysisLimits​(Long categorizationExamplesLimit)

    • AnalysisLimits

      public AnalysisLimits​(Long modelMemoryLimit, Long categorizationExamplesLimit)

  • Method Details

    • getModelMemoryLimit

      @Nullable public Long getModelMemoryLimit()
      Maximum size of the model in MB before the anomaly detector will drop new samples to prevent the model using any more memory.
      Returns:
      The set memory limit or null if not set

    • getCategorizationExamplesLimit

      @Nullable public Long getCategorizationExamplesLimit()
      Gets the limit to the number of examples that are stored per category
      Returns:
      the limit or null if not set

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      IOException

    • equals

      public boolean equals​(Object other)
      Overridden equality test
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object