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:
Streamable
,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 extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
-
-
Field Summary
Fields Modifier and Type Field Description static ConstructingObjectParser<OpenJobRequest,java.lang.Void>
PARSER
static ParseField
TIMEOUT
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description OpenJobRequest(java.lang.String jobId)
Create a new request with the desired jobId
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object other)
static OpenJobRequest
fromXContent(XContentParser parser)
java.lang.String
getJobId()
TimeValue
getTimeout()
int
hashCode()
void
setJobId(java.lang.String jobId)
The jobId to openvoid
setTimeout(TimeValue timeout)
How long to wait for job to open before timing out the requestjava.lang.String
toString()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException
validate()
-
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, readFrom, 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,java.lang.Void> PARSER
-
-
Method Detail
-
fromXContent
public static OpenJobRequest fromXContent(XContentParser parser) throws java.io.IOException
- Throws:
java.io.IOException
-
getJobId
public java.lang.String getJobId()
-
setJobId
public void setJobId(java.lang.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 classActionRequest
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
-
-