Package org.elasticsearch.client.ml
Class DeleteJobRequest
- java.lang.Object
-
- org.elasticsearch.transport.TransportMessage
-
- org.elasticsearch.transport.TransportRequest
-
- org.elasticsearch.action.ActionRequest
-
- org.elasticsearch.client.ml.DeleteJobRequest
-
- All Implemented Interfaces:
Streamable
,Writeable
,TaskAwareRequest
public class DeleteJobRequest extends ActionRequest
Request to delete a Machine Learning Job via its ID
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
-
-
Constructor Summary
Constructors Constructor Description DeleteJobRequest(java.lang.String jobId)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.Boolean
getForce()
java.lang.String
getJobId()
java.lang.Boolean
getWaitForCompletion()
int
hashCode()
void
setForce(java.lang.Boolean force)
Used to forcefully delete an opened job.void
setJobId(java.lang.String jobId)
The jobId which to deletevoid
setWaitForCompletion(java.lang.Boolean waitForCompletion)
Set whether this request should wait until the operation has completed before returningActionRequestValidationException
validate()
-
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, readFrom, writeTo
-
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
-
Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
-
-
-
Method Detail
-
getJobId
public java.lang.String getJobId()
-
setJobId
public void setJobId(java.lang.String jobId)
The jobId which to delete- Parameters:
jobId
- unique jobId to delete, must not be null
-
getForce
public java.lang.Boolean getForce()
-
setForce
public void setForce(java.lang.Boolean force)
Used to forcefully delete an opened job. This method is quicker than closing and deleting the job.- Parameters:
force
- Whentrue
forcefully delete an opened job. Defaults tofalse
-
getWaitForCompletion
public java.lang.Boolean getWaitForCompletion()
-
setWaitForCompletion
public void setWaitForCompletion(java.lang.Boolean waitForCompletion)
Set whether this request should wait until the operation has completed before returning- Parameters:
waitForCompletion
- Whentrue
the call will wait for the job deletion to complete. Otherwise, the deletion will be executed asynchronously and the response will contain the task id.
-
validate
public ActionRequestValidationException validate()
- Specified by:
validate
in classActionRequest
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
-