Class DeleteJobRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.DeleteJobRequest
public class DeleteJobRequest extends RequestBase
Deletes an anomaly detection job.
All job configuration, model state and results are deleted. It is not currently possible to delete multiple jobs using wildcards or a comma separated list. If you delete a job that has a datafeed, the request first tries to delete the datafeed. This behavior is equivalent to calling the delete datafeed API with the same timeout and force parameters as the delete job request.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DeleteJobRequest.Builder
Builder forDeleteJobRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<DeleteJobRequest,DeleteJobResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.delete_job
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
force()
Use to forcefully delete an opened job; this method is quicker than closing and deleting the job.java.lang.String
jobId()
Required - Identifier for the anomaly detection job.static DeleteJobRequest
of(java.util.function.Function<DeleteJobRequest.Builder,ObjectBuilder<DeleteJobRequest>> fn)
java.lang.Boolean
waitForCompletion()
Specifies whether the request should return immediately or wait until the job deletion completes.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "ml.delete_job
".
-
-
Method Details
-
of
public static DeleteJobRequest of(java.util.function.Function<DeleteJobRequest.Builder,ObjectBuilder<DeleteJobRequest>> fn) -
force
@Nullable public final java.lang.Boolean force()Use to forcefully delete an opened job; this method is quicker than closing and deleting the job.API name:
force
-
jobId
public final java.lang.String jobId()Required - Identifier for the anomaly detection job.API name:
job_id
-
waitForCompletion
@Nullable public final java.lang.Boolean waitForCompletion()Specifies whether the request should return immediately or wait until the job deletion completes.API name:
wait_for_completion
-