Package org.opensearch.ml.common.transport.training

Class MLTrainingTaskRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.ml.common.transport.MLTaskRequest

org.opensearch.ml.common.transport.training.MLTrainingTaskRequest

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.tasks.TaskAwareRequest

public class MLTrainingTaskRequest
extends MLTaskRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MLTrainingTaskRequest.MLTrainingTaskRequestBuilder

Nested classes/interfaces inherited from class org.opensearch.transport.TransportRequest

org.opensearch.transport.TransportRequest.Empty

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 inherited from class org.opensearch.ml.common.transport.MLTaskRequest

dispatchTask, requestID

Constructor Summary

Constructors

Constructor	Description
MLTrainingTaskRequest(org.opensearch.core.common.io.stream.StreamInput in)
MLTrainingTaskRequest(MLInput mlInput, boolean async)
MLTrainingTaskRequest(MLInput mlInput, boolean async, boolean dispatchTask)

Method Summary

Modifier and Type	Method	Description
static MLTrainingTaskRequest.MLTrainingTaskRequestBuilder	builder()
static MLTrainingTaskRequest	fromActionRequest(org.opensearch.action.ActionRequest actionRequest)
MLInput	getMlInput()	the name of algorithm
boolean	isAsync()
String	toString()
org.opensearch.action.ActionRequestValidationException	validate()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.ml.common.transport.MLTaskRequest

getRequestID, isDispatchTask, setDispatchTask

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

MLTrainingTaskRequest

public MLTrainingTaskRequest(MLInput mlInput,
 boolean async,
 boolean dispatchTask)

MLTrainingTaskRequest

public MLTrainingTaskRequest(MLInput mlInput,
 boolean async)

MLTrainingTaskRequest

public MLTrainingTaskRequest(org.opensearch.core.common.io.stream.StreamInput in)
                      throws IOException

Throws:

IOException

Method Details

validate

public org.opensearch.action.ActionRequestValidationException validate()

Overrides:

validate in class MLTaskRequest

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

Overrides:

writeTo in class MLTaskRequest

Throws:

IOException

fromActionRequest

public static MLTrainingTaskRequest fromActionRequest(org.opensearch.action.ActionRequest actionRequest)

builder

public static MLTrainingTaskRequest.MLTrainingTaskRequestBuilder builder()

getMlInput

public MLInput getMlInput()

the name of algorithm

isAsync

public boolean isAsync()

toString

public String toString()

Overrides:

toString in class Object