Class AnalysisLimits
java.lang.Object
org.elasticsearch.client.ml.job.config.AnalysisLimits
- All Implemented Interfaces:
ToXContent
,ToXContentObject
public class AnalysisLimits extends java.lang.Object implements 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
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
Field Summary
Fields Modifier and Type Field Description static ParseField
CATEGORIZATION_EXAMPLES_LIMIT
static ParseField
MODEL_MEMORY_LIMIT
Serialisation field namesstatic ConstructingObjectParser<AnalysisLimits,java.lang.Void>
PARSER
-
Constructor Summary
Constructors Constructor Description AnalysisLimits(java.lang.Long categorizationExamplesLimit)
AnalysisLimits(java.lang.Long modelMemoryLimit, java.lang.Long categorizationExamplesLimit)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object other)
Overridden equality testjava.lang.Long
getCategorizationExamplesLimit()
Gets the limit to the number of examples that are stored per categoryjava.lang.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()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
-
Field Details
-
MODEL_MEMORY_LIMIT
Serialisation field names -
CATEGORIZATION_EXAMPLES_LIMIT
-
PARSER
-
-
Constructor Details
-
AnalysisLimits
public AnalysisLimits(java.lang.Long categorizationExamplesLimit) -
AnalysisLimits
public AnalysisLimits(java.lang.Long modelMemoryLimit, java.lang.Long categorizationExamplesLimit)
-
-
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 XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object other)Overridden equality test- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-