Package org.opensearch.jobscheduler.transport.request

Class JobRunnerRequest

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.transport.TransportRequest
org.opensearch.action.ActionRequest
org.opensearch.jobscheduler.transport.request.JobRunnerRequest
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.tasks.TaskAwareRequest
public class JobRunnerRequest extends org.opensearch.action.ActionRequest
Request to extensions to invoke their ScheduledJobRunner implementation

  • 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>

  • Constructor Summary

    Constructors
    Constructor
    Description
    JobRunnerRequest(byte[] requestParams)
    Instantiates a new Job Runner Request by wrapping the given byte array within a StreamInput
    JobRunnerRequest(String accessToken, String jobParameterDocumentId, org.opensearch.jobscheduler.spi.JobExecutionContext jobExecutionContext)
    Instantiates a new Job Runner Request
    JobRunnerRequest(org.opensearch.core.common.io.stream.StreamInput in)
    Instantiates a new Job Runner Request from StreamInput

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAccessToken()
     
    org.opensearch.jobscheduler.spi.JobExecutionContext
    getJobExecutionContext()
     
    String
    getJobParameterDocumentId()
     
    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

  • Constructor Details

    • JobRunnerRequest

      public JobRunnerRequest(String accessToken, String jobParameterDocumentId, org.opensearch.jobscheduler.spi.JobExecutionContext jobExecutionContext)
      Instantiates a new Job Runner Request
      Parameters:
      accessToken - the access token of this request
      jobParameterDocumentId - the document id of the job parameter
      jobExecutionContext - the context used to facilitate a job run

    • JobRunnerRequest

      public JobRunnerRequest(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Instantiates a new Job Runner Request from StreamInput
      Parameters:
      in - is the byte stream input used to de-serialize the message.
      Throws:
      IOException - IOException when message de-serialization fails.

    • JobRunnerRequest

      public JobRunnerRequest(byte[] requestParams) throws IOException
      Instantiates a new Job Runner Request by wrapping the given byte array within a StreamInput
      Parameters:
      requestParams - in bytes array used to de-serialize the message.
      Throws:
      IOException - when message de-serialization fails.

  • 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

    • getAccessToken

      public String getAccessToken()

    • getJobParameterDocumentId

      public String getJobParameterDocumentId()

    • getJobExecutionContext

      public org.opensearch.jobscheduler.spi.JobExecutionContext getJobExecutionContext()