Package org.elasticsearch.client.ml
Class DeleteJobRequest
java.lang.Object
org.elasticsearch.client.ml.DeleteJobRequest
- All Implemented Interfaces:
Validatable
Request to delete a Machine Learning Job via its ID
-
Field Summary
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
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 returningMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
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.
-
hashCode
public int hashCode() -
equals
-