Package org.elasticsearch.client.ml

Class ResetJobRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.client.ml.ResetJobRequest

All Implemented Interfaces:

Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest

public class ResetJobRequest
extends ActionRequest

Request to delete a Machine Learning Job via its ID

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>

Constructor Summary

Constructors

Constructor	Description
ResetJobRequest(String jobId)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getJobId()
Boolean	getWaitForCompletion()
int	hashCode()
void	setJobId(String jobId)	The jobId which to reset
void	setWaitForCompletion(Boolean waitForCompletion)	Set whether this request should wait until the operation has completed before returning
ActionRequestValidationException	validate()

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult, writeTo

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

ResetJobRequest

public ResetJobRequest(String jobId)

Method Details

getJobId

public String getJobId()

setJobId

public void setJobId(String jobId)

The jobId which to reset

Parameters:

jobId - unique jobId to reset, must not be null

getWaitForCompletion

public Boolean getWaitForCompletion()

setWaitForCompletion

public void setWaitForCompletion(Boolean waitForCompletion)

Set whether this request should wait until the operation has completed before returning

Parameters:

waitForCompletion - When true the call will wait for the job reset to complete. Otherwise, the reset will be executed asynchronously and the response will contain the task id.

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object