Package org.elasticsearch.client.ml

Class EstimateModelMemoryRequest

java.lang.Object

org.elasticsearch.client.ml.EstimateModelMemoryRequest

All Implemented Interfaces:

Validatable, ToXContent, ToXContentObject

public class EstimateModelMemoryRequest
extends java.lang.Object
implements Validatable, ToXContentObject

Request to estimate the model memory an analysis config is likely to need given supplied field cardinalities.

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 java.lang.String	ANALYSIS_CONFIG
static java.lang.String	MAX_BUCKET_CARDINALITY
static java.lang.String	OVERALL_CARDINALITY

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

EMPTY_PARAMS

Fields inherited from interface org.elasticsearch.client.Validatable

EMPTY

Constructor Summary

Constructors

Constructor	Description
EstimateModelMemoryRequest(AnalysisConfig analysisConfig)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
AnalysisConfig	getAnalysisConfig()
java.util.Map<java.lang.String,java.lang.Long>	getMaxBucketCardinality()
java.util.Map<java.lang.String,java.lang.Long>	getOverallCardinality()
int	hashCode()
void	setMaxBucketCardinality(java.util.Map<java.lang.String,java.lang.Long> maxBucketCardinality)
void	setOverallCardinality(java.util.Map<java.lang.String,java.lang.Long> overallCardinality)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
java.util.Optional<ValidationException>	validate()	Perform validation.

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

ANALYSIS_CONFIG

public static final java.lang.String ANALYSIS_CONFIG

See Also:

Constant Field Values

OVERALL_CARDINALITY

public static final java.lang.String OVERALL_CARDINALITY

See Also:

Constant Field Values

MAX_BUCKET_CARDINALITY

public static final java.lang.String MAX_BUCKET_CARDINALITY

See Also:

Constant Field Values

Constructor Details

EstimateModelMemoryRequest

public EstimateModelMemoryRequest(AnalysisConfig analysisConfig)

Method Details

validate

public java.util.Optional<ValidationException> validate()

Description copied from interface: Validatable

Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. A ValidationException that is not null is assumed to contain validation errors and will be thrown.

Specified by:

validate in interface Validatable

Returns:

An Optional ValidationException that contains a list of validation errors.

getAnalysisConfig

public AnalysisConfig getAnalysisConfig()

getOverallCardinality

public java.util.Map<java.lang.String,java.lang.Long> getOverallCardinality()

setOverallCardinality

public void setOverallCardinality(java.util.Map<java.lang.String,java.lang.Long> overallCardinality)

getMaxBucketCardinality

public java.util.Map<java.lang.String,java.lang.Long> getMaxBucketCardinality()

setMaxBucketCardinality

public void setMaxBucketCardinality(java.util.Map<java.lang.String,java.lang.Long> maxBucketCardinality)

toXContent

public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object