Class DeleteJobRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.DeleteJobRequest
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<DeleteJobRequest,
DeleteJobResponse, ErrorResponse> Endpoint "ml.delete_job
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
force()
Use to forcefully delete an opened job; this method is quicker than closing and deleting the job.final String
jobId()
Required - Identifier for the anomaly detection job.static DeleteJobRequest
final Boolean
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
-
Field Details
-
_ENDPOINT
Endpoint "ml.delete_job
".
-
-
Method Details
-
of
public static DeleteJobRequest of(Function<DeleteJobRequest.Builder, ObjectBuilder<DeleteJobRequest>> fn) -
force
Use to forcefully delete an opened job; this method is quicker than closing and deleting the job.API name:
force
-
jobId
Required - Identifier for the anomaly detection job.API name:
job_id
-
waitForCompletion
Specifies whether the request should return immediately or wait until the job deletion completes.API name:
wait_for_completion
-