Package org.elasticsearch.client.ml.job.process

Enum Class ModelSizeStats.AssignmentMemoryBasis

java.lang.Object

java.lang.Enum<ModelSizeStats.AssignmentMemoryBasis>

org.elasticsearch.client.ml.job.process.ModelSizeStats.AssignmentMemoryBasis

All Implemented Interfaces:

Serializable, Comparable<ModelSizeStats.AssignmentMemoryBasis>, Constable

Enclosing class:

ModelSizeStats

public static enum ModelSizeStats.AssignmentMemoryBasis
extends Enum<ModelSizeStats.AssignmentMemoryBasis>

Where will we get the memory requirement from when assigning this job to a node? There are three possibilities: 1. The job's model_memory_limit 2. The current model memory, i.e. what's reported in model_bytes of this object 3. The peak model memory, i.e. what's reported in peak_model_bytes of this object The field storing this enum can also be null, which means the assignment code will decide on the fly - this was the old behaviour prior to 7.11.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CURRENT_MODEL_BYTES
MODEL_MEMORY_LIMIT
PEAK_MODEL_BYTES

Method Summary

Modifier and Type	Method	Description
static ModelSizeStats.AssignmentMemoryBasis	fromString(String statusName)
String	toString()
static ModelSizeStats.AssignmentMemoryBasis	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ModelSizeStats.AssignmentMemoryBasis[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MODEL_MEMORY_LIMIT

public static final ModelSizeStats.AssignmentMemoryBasis MODEL_MEMORY_LIMIT

CURRENT_MODEL_BYTES

public static final ModelSizeStats.AssignmentMemoryBasis CURRENT_MODEL_BYTES

PEAK_MODEL_BYTES

public static final ModelSizeStats.AssignmentMemoryBasis PEAK_MODEL_BYTES

Method Details

values

public static ModelSizeStats.AssignmentMemoryBasis[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ModelSizeStats.AssignmentMemoryBasis valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static ModelSizeStats.AssignmentMemoryBasis fromString(String statusName)

toString

public String toString()

Overrides:

toString in class Enum<ModelSizeStats.AssignmentMemoryBasis>