Package org.opensearch.ml.common.transport.model

Class MLModelGetRequest

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.transport.TransportRequest
org.opensearch.action.ActionRequest
org.opensearch.ml.common.transport.model.MLModelGetRequest
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.tasks.TaskAwareRequest
public class MLModelGetRequest extends org.opensearch.action.ActionRequest

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    MLModelGetRequest.MLModelGetRequestBuilder
     

    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>

  • Constructor Summary

    Constructors
    Constructor
    Description
    MLModelGetRequest(String modelId, boolean returnContent, boolean isUserInitiatedGetRequest)
     
    MLModelGetRequest(org.opensearch.core.common.io.stream.StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static MLModelGetRequest.MLModelGetRequestBuilder
    builder()
     
    static MLModelGetRequest
    fromActionRequest(org.opensearch.action.ActionRequest actionRequest)
     
    String
    getModelId()
     
    boolean
    isReturnContent()
     
    boolean
    isUserInitiatedGetRequest()
     
    String
    toString()
     
    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, wait, wait, wait

    Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

    createTask, getDescription, setParentTask

  • Constructor Details

    • MLModelGetRequest

      public MLModelGetRequest(String modelId, boolean returnContent, boolean isUserInitiatedGetRequest)

    • MLModelGetRequest

      public MLModelGetRequest(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

    • fromActionRequest

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

    • builder

      public static MLModelGetRequest.MLModelGetRequestBuilder builder()

    • getModelId

      public String getModelId()

    • isReturnContent

      public boolean isReturnContent()

    • isUserInitiatedGetRequest

      public boolean isUserInitiatedGetRequest()

    • toString

      public String toString()
      Overrides:
      toString in class Object