Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.action

Class OpenJobAction.JobParams

java.lang.Object

org.elasticsearch.xpack.core.ml.action.OpenJobAction.JobParams

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, PersistentTaskParams, ToXContent, ToXContentObject, MlTaskParams

Enclosing class:

OpenJobAction

public static class OpenJobAction.JobParams
extends Object
implements PersistentTaskParams, MlTaskParams

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.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 final ParseField	JOB
static final ObjectParser<OpenJobAction.JobParams,Void>	PARSER
static final ParseField	TIMEOUT

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
JobParams(String jobId)
JobParams(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static OpenJobAction.JobParams	fromXContent(XContentParser parser)
Job	getJob()
String	getJobId()
TransportVersion	getMinimalSupportedVersion()
String	getMlId()	The id of the ML config this task is executing
TimeValue	getTimeout()
String	getWriteableName()
int	hashCode()
static OpenJobAction.JobParams	parseRequest(String jobId, XContentParser parser)
void	setJob(Job job)
void	setJobId(String jobId)
void	setTimeout(TimeValue timeout)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

TIMEOUT

public static final ParseField TIMEOUT

JOB

public static final ParseField JOB

PARSER

public static final ObjectParser<OpenJobAction.JobParams,Void> PARSER

Constructor Details

JobParams

public JobParams(String jobId)

JobParams

public JobParams(StreamInput in)
          throws IOException

Throws:

IOException

Method Details

fromXContent

public static OpenJobAction.JobParams fromXContent(XContentParser parser)

parseRequest

public static OpenJobAction.JobParams parseRequest(String jobId,
 XContentParser parser)

getJobId

public String getJobId()

setJobId

public void setJobId(String jobId)

getTimeout

public TimeValue getTimeout()

setTimeout

public void setTimeout(TimeValue timeout)

getJob

@Nullable
public Job getJob()

setJob

public void setJob(Job job)

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

getMlId

public String getMlId()

Description copied from interface: MlTaskParams

The id of the ML config this task is executing

Specified by:

getMlId in interface MlTaskParams