Class AnalysisLimits
java.lang.Object
org.elasticsearch.client.ml.job.config.AnalysisLimits
- All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.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.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
static final org.elasticsearch.xcontent.ParseField
Serialisation field namesstatic final org.elasticsearch.xcontent.ConstructingObjectParser<AnalysisLimits,
Void> Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionAnalysisLimits
(Long categorizationExamplesLimit) AnalysisLimits
(Long modelMemoryLimit, Long categorizationExamplesLimit) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Overridden equality testGets the limit to the number of examples that are stored per categoryMaximum 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.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
-
MODEL_MEMORY_LIMIT
public static final org.elasticsearch.xcontent.ParseField MODEL_MEMORY_LIMITSerialisation field names -
CATEGORIZATION_EXAMPLES_LIMIT
public static final org.elasticsearch.xcontent.ParseField CATEGORIZATION_EXAMPLES_LIMIT -
PARSER
-
-
Constructor Details
-
AnalysisLimits
-
AnalysisLimits
-
-
Method Details
-
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
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.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
Overridden equality test -
hashCode
public int hashCode()
-