Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.action

Class StartTrainedModelDeploymentAction.TaskParams

java.lang.Object

org.elasticsearch.xpack.core.ml.action.StartTrainedModelDeploymentAction.TaskParams

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject, MlTaskParams

Enclosing class:

StartTrainedModelDeploymentAction

public static class StartTrainedModelDeploymentAction.TaskParams
extends Object
implements MlTaskParams, Writeable, ToXContentObject

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	CACHE_SIZE
static final ParseField	LEGACY_INFERENCE_THREADS
static final ParseField	NUMBER_OF_ALLOCATIONS
static final ParseField	PER_ALLOCATION_MEMORY_BYTES
static final ParseField	PER_DEPLOYMENT_MEMORY_BYTES
static final ParseField	PRIORITY
static final ParseField	QUEUE_CAPACITY
static final ParseField	THREADS_PER_ALLOCATION

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TaskParams(String modelId, String deploymentId, long modelBytes, int numberOfAllocations, int threadsPerAllocation, int queueCapacity, ByteSizeValue cacheSize, Priority priority, long perDeploymentMemoryBytes, long perAllocationMemoryBytes)
TaskParams(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
long	estimateMemoryUsageBytes()
static StartTrainedModelDeploymentAction.TaskParams	fromXContent(XContentParser parser)
Optional<ByteSizeValue>	getCacheSize()
long	getCacheSizeBytes()
String	getDeploymentId()
String	getMlId()	The id of the ML config this task is executing
long	getModelBytes()
String	getModelId()
int	getNumberOfAllocations()
long	getPerAllocationMemoryBytes()
long	getPerDeploymentMemoryBytes()
Priority	getPriority()
int	getQueueCapacity()
int	getThreadsPerAllocation()
int	hashCode()
static boolean	mayAssignToNode(DiscoveryNode node)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NUMBER_OF_ALLOCATIONS

public static final ParseField NUMBER_OF_ALLOCATIONS

THREADS_PER_ALLOCATION

public static final ParseField THREADS_PER_ALLOCATION

LEGACY_INFERENCE_THREADS

public static final ParseField LEGACY_INFERENCE_THREADS

QUEUE_CAPACITY

public static final ParseField QUEUE_CAPACITY

CACHE_SIZE

public static final ParseField CACHE_SIZE

PRIORITY

public static final ParseField PRIORITY

PER_DEPLOYMENT_MEMORY_BYTES

public static final ParseField PER_DEPLOYMENT_MEMORY_BYTES

PER_ALLOCATION_MEMORY_BYTES

public static final ParseField PER_ALLOCATION_MEMORY_BYTES

Constructor Details

TaskParams

public TaskParams(String modelId,
 String deploymentId,
 long modelBytes,
 int numberOfAllocations,
 int threadsPerAllocation,
 int queueCapacity,
 @Nullable
 ByteSizeValue cacheSize,
 Priority priority,
 long perDeploymentMemoryBytes,
 long perAllocationMemoryBytes)

TaskParams

public TaskParams(StreamInput in)
           throws IOException

Throws:

IOException

Method Details

mayAssignToNode

public static boolean mayAssignToNode(@Nullable
 DiscoveryNode node)

fromXContent

public static StartTrainedModelDeploymentAction.TaskParams fromXContent(XContentParser parser)

getModelId

public String getModelId()

getDeploymentId

public String getDeploymentId()

estimateMemoryUsageBytes

public long estimateMemoryUsageBytes()

Returns:

the estimated memory (in bytes) required for the model deployment to run

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getMlId

public String getMlId()

Description copied from interface: MlTaskParams

The id of the ML config this task is executing

Specified by:

getMlId in interface MlTaskParams

getModelBytes

public long getModelBytes()

getThreadsPerAllocation

public int getThreadsPerAllocation()

Returns:

the number of threads per allocation used by the model during inference. each thread requires one processor.

getNumberOfAllocations

public int getNumberOfAllocations()

Returns:

the number of allocations requested by the user

getQueueCapacity

public int getQueueCapacity()

getCacheSize

public Optional<ByteSizeValue> getCacheSize()

getCacheSizeBytes

public long getCacheSizeBytes()

getPriority

public Priority getPriority()

getPerAllocationMemoryBytes

public long getPerAllocationMemoryBytes()

getPerDeploymentMemoryBytes

public long getPerDeploymentMemoryBytes()

toString

public String toString()

Overrides:

toString in class Object