Package org.opensearch.ml.common.transport

Class MLTaskRequest

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.transport.TransportRequest
org.opensearch.action.ActionRequest
org.opensearch.ml.common.transport.MLTaskRequest
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.tasks.TaskAwareRequest
Direct Known Subclasses:
MLDeployModelRequest, MLExecuteTaskRequest, MLPredictionTaskRequest, MLTrainingTaskRequest, MLUndeployModelsRequest
public class MLTaskRequest extends org.opensearch.action.ActionRequest

  • Nested Class Summary

    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
    Modifier and Type
    Field
    Description
    protected boolean
    dispatchTask
     
    protected final String
    requestID
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    MLTaskRequest(boolean dispatchTask)
     
    MLTaskRequest(org.opensearch.core.common.io.stream.StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getRequestID()
     
    boolean
    isDispatchTask()
     
    void
    setDispatchTask(boolean dispatchTask)
     
    org.opensearch.action.ActionRequestValidationException
    validate()
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    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, toString, wait, wait, wait

    Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

    createTask, getDescription, setParentTask

  • Field Details

    • dispatchTask

      protected boolean dispatchTask

    • requestID

      protected final String requestID

  • Constructor Details

    • MLTaskRequest

      public MLTaskRequest(boolean dispatchTask)

    • MLTaskRequest

      public MLTaskRequest(org.opensearch.core.common.io.stream.StreamInput in) 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
      Overrides:
      writeTo in class org.opensearch.action.ActionRequest
      Throws:
      IOException

    • validate

      public org.opensearch.action.ActionRequestValidationException validate()
      Specified by:
      validate in class org.opensearch.action.ActionRequest

    • isDispatchTask

      public boolean isDispatchTask()

    • getRequestID

      public String getRequestID()

    • setDispatchTask

      public void setDispatchTask(boolean dispatchTask)