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

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 names
static ConstructingObjectParser<AnalysisLimits,java.lang.Void>	PARSER

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

EMPTY_PARAMS

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 test
java.lang.Long	getCategorizationExamplesLimit()	Gets the limit to the number of examples that are stored per category
java.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)

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 ParseField MODEL_MEMORY_LIMIT

Serialisation field names

CATEGORIZATION_EXAMPLES_LIMIT

public static final ParseField CATEGORIZATION_EXAMPLES_LIMIT

PARSER

public static final ConstructingObjectParser<AnalysisLimits,java.lang.Void> PARSER

Constructor Details

AnalysisLimits

public AnalysisLimits(java.lang.Long categorizationExamplesLimit)

AnalysisLimits

public AnalysisLimits(java.lang.Long modelMemoryLimit, java.lang.Long categorizationExamplesLimit)

Method Details

getModelMemoryLimit

@Nullable public java.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.

Returns:

The set memory limit or null if not set

getCategorizationExamplesLimit

@Nullable public java.lang.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 XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object other)

Overridden equality test

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object