Package org.opensearch.jobscheduler.rest.request

Class GetJobDetailsRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.jobscheduler.rest.request.GetJobDetailsRequest

All Implemented Interfaces:

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

public class GetJobDetailsRequest
extends org.opensearch.action.ActionRequest

Get Job Details Request Model class

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
static final String	DOCUMENT_ID
static final String	EXTENSION_UNIQUE_ID
static final String	JOB_INDEX
static final String	JOB_PARAMETER_ACTION
static final String	JOB_RUNNER_ACTION
static final String	JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
GetJobDetailsRequest(String documentId, String jobIndex, String jobType, String jobParameterAction, String jobRunnerAction, String extensionUniqueId)
GetJobDetailsRequest(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	getDocumentId()
String	getExtensionUniqueId()
String	getJobIndex()
String	getJobParameterAction()
String	getJobRunnerAction()
String	getJobType()
static GetJobDetailsRequest	parse(org.opensearch.core.xcontent.XContentParser parser)
void	setDocumentId(String documentId)
void	setExtensionUniqueId(String extensionUniqueId)
void	setJobIndex(String jobIndex)
void	setJobParameterAction(String jobParameterAction)
void	setJobRunnerAction(String jobRunnerAction)
void	setJobType(String jobType)
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

DOCUMENT_ID

public static final String DOCUMENT_ID

See Also:

• Constant Field Values

JOB_INDEX

public static final String JOB_INDEX

See Also:

• Constant Field Values

JOB_TYPE

public static final String JOB_TYPE

See Also:

• Constant Field Values

EXTENSION_UNIQUE_ID

public static final String EXTENSION_UNIQUE_ID

See Also:

• Constant Field Values

JOB_PARAMETER_ACTION

public static final String JOB_PARAMETER_ACTION

See Also:

• Constant Field Values

JOB_RUNNER_ACTION

public static final String JOB_RUNNER_ACTION

See Also:

• Constant Field Values

Constructor Details

GetJobDetailsRequest

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

Throws:

IOException

GetJobDetailsRequest

public GetJobDetailsRequest(String documentId,
 String jobIndex,
 String jobType,
 String jobParameterAction,
 String jobRunnerAction,
 String extensionUniqueId)

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

getDocumentId

public String getDocumentId()

setDocumentId

public void setDocumentId(String documentId)

getJobIndex

public String getJobIndex()

setJobIndex

public void setJobIndex(String jobIndex)

getJobType

public String getJobType()

setJobType

public void setJobType(String jobType)

getJobParameterAction

public String getJobParameterAction()

setJobParameterAction

public void setJobParameterAction(String jobParameterAction)

getJobRunnerAction

public String getJobRunnerAction()

setJobRunnerAction

public void setJobRunnerAction(String jobRunnerAction)

getExtensionUniqueId

public String getExtensionUniqueId()

setExtensionUniqueId

public void setExtensionUniqueId(String extensionUniqueId)

validate

public org.opensearch.action.ActionRequestValidationException validate()

Specified by:

validate in class org.opensearch.action.ActionRequest

parse

public static GetJobDetailsRequest parse(org.opensearch.core.xcontent.XContentParser parser)
                                  throws IOException

Throws:

IOException