Package org.elasticsearch.client.ml

Class OpenJobRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.client.ml.OpenJobRequest

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject, TaskAwareRequest

public class OpenJobRequest
extends ActionRequest
implements ToXContentObject

Request to open a Machine Learning Job

Nested Class Summary

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

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static ConstructingObjectParser<OpenJobRequest,Void>	PARSER
static ParseField	TIMEOUT

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
OpenJobRequest(String jobId)	Create a new request with the desired jobId

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
static OpenJobRequest	fromXContent(XContentParser parser)
String	getJobId()
TimeValue	getTimeout()
int	hashCode()
void	setJobId(String jobId)	The jobId to open
void	setTimeout(TimeValue timeout)	How long to wait for job to open before timing out the request
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult, writeTo

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Detail

TIMEOUT

public static final ParseField TIMEOUT

PARSER

public static final ConstructingObjectParser<OpenJobRequest,Void> PARSER

Constructor Detail

OpenJobRequest

public OpenJobRequest(String jobId)

Create a new request with the desired jobId

Parameters:

jobId - unique jobId, must not be null

Method Detail

fromXContent

public static OpenJobRequest fromXContent(XContentParser parser)
                                   throws IOException

Throws:

IOException

getJobId

public String getJobId()

setJobId

public void setJobId(String jobId)

The jobId to open

Parameters:

jobId - unique jobId, must not be null

getTimeout

public TimeValue getTimeout()

setTimeout

public void setTimeout(TimeValue timeout)

How long to wait for job to open before timing out the request

Parameters:

timeout - default value of 30 minutes

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object