Package org.opensearch.ml.common

Class MLTask

java.lang.Object

org.opensearch.ml.common.MLTask

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

public class MLTask
extends Object
implements org.opensearch.core.xcontent.ToXContentObject, org.opensearch.core.common.io.stream.Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MLTask.MLTaskBuilder

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CREATE_TIME_FIELD
static final String	ERROR_FIELD
static final String	FUNCTION_NAME_FIELD
static final String	INPUT_TYPE_FIELD
static final String	IS_ASYNC_TASK_FIELD
static final String	LAST_UPDATE_TIME_FIELD
static final String	MODEL_ID_FIELD
static final String	OUTPUT_INDEX_FIELD
static final String	PROGRESS_FIELD
static final String	STATE_FIELD
static final String	TASK_ID_FIELD
static final String	TASK_TYPE_FIELD
static final String	WORKER_NODE_FIELD

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MLTask(String taskId, String modelId, MLTaskType taskType, FunctionName functionName, MLTaskState state, MLInputDataType inputType, Float progress, String outputIndex, List<String> workerNodes, Instant createTime, Instant lastUpdateTime, String error, org.opensearch.commons.authuser.User user, boolean async)
MLTask(org.opensearch.core.common.io.stream.StreamInput input)

Method Summary

Modifier and Type	Method	Description
static MLTask.MLTaskBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static MLTask	fromStream(org.opensearch.core.common.io.stream.StreamInput in)
Instant	getCreateTime()
String	getError()
FunctionName	getFunctionName()
MLInputDataType	getInputType()
Instant	getLastUpdateTime()
String	getModelId()
String	getOutputIndex()
Float	getProgress()
MLTaskState	getState()
String	getTaskId()
MLTaskType	getTaskType()
org.opensearch.commons.authuser.User	getUser()
List<String>	getWorkerNodes()
int	hashCode()
boolean	isAsync()
static MLTask	parse(org.opensearch.core.xcontent.XContentParser parser)
void	setError(String error)
void	setFunctionName(FunctionName functionName)
void	setModelId(String modelId)
void	setState(MLTaskState state)
void	setTaskId(String taskId)
void	setWorkerNodes(List<String> workerNodes)
MLTask.MLTaskBuilder	toBuilder()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder xContentBuilder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

TASK_ID_FIELD

public static final String TASK_ID_FIELD

See Also:

• Constant Field Values

MODEL_ID_FIELD

public static final String MODEL_ID_FIELD

See Also:

• Constant Field Values

TASK_TYPE_FIELD

public static final String TASK_TYPE_FIELD

See Also:

• Constant Field Values

FUNCTION_NAME_FIELD

public static final String FUNCTION_NAME_FIELD

See Also:

• Constant Field Values

STATE_FIELD

public static final String STATE_FIELD

See Also:

• Constant Field Values

INPUT_TYPE_FIELD

public static final String INPUT_TYPE_FIELD

See Also:

• Constant Field Values

PROGRESS_FIELD

public static final String PROGRESS_FIELD

See Also:

• Constant Field Values

OUTPUT_INDEX_FIELD

public static final String OUTPUT_INDEX_FIELD

See Also:

• Constant Field Values

WORKER_NODE_FIELD

public static final String WORKER_NODE_FIELD

See Also:

• Constant Field Values

CREATE_TIME_FIELD

public static final String CREATE_TIME_FIELD

See Also:

• Constant Field Values

LAST_UPDATE_TIME_FIELD

public static final String LAST_UPDATE_TIME_FIELD

See Also:

• Constant Field Values

ERROR_FIELD

public static final String ERROR_FIELD

See Also:

• Constant Field Values

IS_ASYNC_TASK_FIELD

public static final String IS_ASYNC_TASK_FIELD

See Also:

• Constant Field Values

Constructor Details

MLTask

public MLTask(String taskId,
 String modelId,
 MLTaskType taskType,
 FunctionName functionName,
 MLTaskState state,
 MLInputDataType inputType,
 Float progress,
 String outputIndex,
 List<String> workerNodes,
 Instant createTime,
 Instant lastUpdateTime,
 String error,
 org.opensearch.commons.authuser.User user,
 boolean async)

MLTask

public MLTask(org.opensearch.core.common.io.stream.StreamInput input)
       throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder xContentBuilder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

fromStream

public static MLTask fromStream(org.opensearch.core.common.io.stream.StreamInput in)
                         throws IOException

Throws:

IOException

parse

public static MLTask parse(org.opensearch.core.xcontent.XContentParser parser)
                    throws IOException

Throws:

IOException

builder

public static MLTask.MLTaskBuilder builder()

toBuilder

public MLTask.MLTaskBuilder toBuilder()

getTaskId

public String getTaskId()

getModelId

public String getModelId()

getTaskType

public MLTaskType getTaskType()

getFunctionName

public FunctionName getFunctionName()

getState

public MLTaskState getState()

getInputType

public MLInputDataType getInputType()

getProgress

public Float getProgress()

getOutputIndex

public String getOutputIndex()

getWorkerNodes

public List<String> getWorkerNodes()

getCreateTime

public Instant getCreateTime()

getLastUpdateTime

public Instant getLastUpdateTime()

getError

public String getError()

getUser

public org.opensearch.commons.authuser.User getUser()

isAsync

public boolean isAsync()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setTaskId

public void setTaskId(String taskId)

setModelId

public void setModelId(String modelId)

setFunctionName

public void setFunctionName(FunctionName functionName)

setState

public void setState(MLTaskState state)

setWorkerNodes

public void setWorkerNodes(List<String> workerNodes)

setError

public void setError(String error)