Package org.opensearch.jobscheduler.transport.request

Class JobParameterRequest

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.transport.TransportRequest
org.opensearch.action.ActionRequest
org.opensearch.jobscheduler.transport.request.JobParameterRequest
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.tasks.TaskAwareRequest
public class JobParameterRequest extends org.opensearch.action.ActionRequest
Request to extensions to parse a ScheduledJobParameter

  • 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
    JobParameterRequest(byte[] requestParams)
    Instantiates a new Job Parameter Request by wrapping the given byte array within a StreamInput
    JobParameterRequest(String accessToken, org.opensearch.core.xcontent.XContentParser jobParser, String id, org.opensearch.jobscheduler.spi.JobDocVersion jobDocVersion)
    Instantiates a new Job Parameter Request
    JobParameterRequest(org.opensearch.core.common.io.stream.StreamInput in)
    Instantiates a new Job Parameter Request from StreamInput

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAccessToken()
     
    String
    getId()
     
    org.opensearch.jobscheduler.spi.JobDocVersion
    getJobDocVersion()
     
    org.opensearch.core.common.bytes.BytesReference
    getJobSource()
     
    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

    • JobParameterRequest

      public JobParameterRequest(String accessToken, org.opensearch.core.xcontent.XContentParser jobParser, String id, org.opensearch.jobscheduler.spi.JobDocVersion jobDocVersion) throws IOException
      Instantiates a new Job Parameter Request
      Parameters:
      accessToken - the user identiy/access token that will be validated prior to triggering an extension action
      jobParser - the parser obect to extract the jobSource BytesReference from
      id - the job id
      jobDocVersion - the job document version
      Throws:
      IOException - IOException when message de-serialization fails.

    • JobParameterRequest

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

    • JobParameterRequest

      public JobParameterRequest(byte[] requestParams) throws IOException
      Instantiates a new Job Parameter 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()

    • getJobSource

      public org.opensearch.core.common.bytes.BytesReference getJobSource()

    • getId

      public String getId()

    • getJobDocVersion

      public org.opensearch.jobscheduler.spi.JobDocVersion getJobDocVersion()