Package co.elastic.clients.elasticsearch.ml

Class ResetJobRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.ResetJobRequest

public class ResetJobRequest
extends RequestBase

Reset an anomaly detection job. All model state and results are deleted. The job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResetJobRequest.Builder	Builder for ResetJobRequest.

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<ResetJobRequest,ResetJobResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.reset_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 String	jobId()	Required - The ID of the job to reset.
static ResetJobRequest	of(Function<ResetJobRequest.Builder,ObjectBuilder<ResetJobRequest>> fn)
final Boolean	waitForCompletion()	Should this request wait until the operation has completed before returning.

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<ResetJobRequest,ResetJobResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.reset_job".

Method Details

of

public static ResetJobRequest of(Function<ResetJobRequest.Builder,ObjectBuilder<ResetJobRequest>> 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

jobId

public final String jobId()

Required - The ID of the job to reset.

API name: job_id

waitForCompletion

@Nullable
public final Boolean waitForCompletion()

Should this request wait until the operation has completed before returning.

API name: wait_for_completion