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:
Writeable
,org.elasticsearch.core.RefCounted
,TaskAwareRequest
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 Object>, Writeable.Writer<V extends Object>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
getForce()
getJobId()
int
hashCode()
void
Used to forcefully delete an opened job.void
The jobId which to deletevoid
setWaitForCompletion
(Boolean waitForCompletion) Set whether this request should wait until the operation has completed before returningvalidate()
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, writeTo
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
DeleteJobRequest
-
-
Method Details
-
getJobId
-
setJobId
The jobId which to delete- Parameters:
jobId
- unique jobId to delete, must not be null
-
getForce
-
setForce
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
-
setWaitForCompletion
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
- Specified by:
validate
in classActionRequest
-
hashCode
public int hashCode() -
equals
-