Package co.elastic.clients.elasticsearch.ml

Class DeleteJobRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.DeleteJobRequest

public class DeleteJobRequest
extends RequestBase

Delete 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 for DeleteJobRequest.

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 final Endpoint<DeleteJobRequest,DeleteJobResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.delete_job".

Method Summary

Modifier and Type	Method	Description
final Boolean	deleteUserAnnotations()	Specifies whether annotations that have been added by the user should be deleted along with any auto-generated annotations when the job is reset.
final 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	of(Function<DeleteJobRequest.Builder,ObjectBuilder<DeleteJobRequest>> fn)
final 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

public static final Endpoint<DeleteJobRequest,DeleteJobResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.delete_job".

Method Details

of

public static DeleteJobRequest of(Function<DeleteJobRequest.Builder,ObjectBuilder<DeleteJobRequest>> fn)

deleteUserAnnotations

@Nullable
public final Boolean deleteUserAnnotations()

Specifies whether annotations that have been added by the user should be deleted along with any auto-generated annotations when the job is reset.

API name: delete_user_annotations

force

@Nullable
public final 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 String jobId()

Required - Identifier for the anomaly detection job.

API name: job_id

waitForCompletion

@Nullable
public final Boolean waitForCompletion()

Specifies whether the request should return immediately or wait until the job deletion completes.

API name: wait_for_completion