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
,org.elasticsearch.core.RefCounted
,TaskAwareRequest
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class OpenJobRequest
extends ActionRequest
implements org.elasticsearch.xcontent.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.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ConstructingObjectParser<OpenJobRequest,
Void> static final org.elasticsearch.xcontent.ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
static OpenJobRequest
fromXContent
(org.elasticsearch.xcontent.XContentParser parser) getJobId()
org.elasticsearch.core.TimeValue
int
hashCode()
void
The jobId to openvoid
setTimeout
(org.elasticsearch.core.TimeValue timeout) How long to wait for job to open before timing out the requesttoString()
org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) 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
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
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
TIMEOUT
public static final org.elasticsearch.xcontent.ParseField TIMEOUT -
PARSER
-
-
Constructor Details
-
OpenJobRequest
Create a new request with the desired jobId- Parameters:
jobId
- unique jobId, must not be null
-
-
Method Details
-
fromXContent
public static OpenJobRequest fromXContent(org.elasticsearch.xcontent.XContentParser parser) throws IOException - Throws:
IOException
-
getJobId
-
setJobId
The jobId to open- Parameters:
jobId
- unique jobId, must not be null
-
getTimeout
public org.elasticsearch.core.TimeValue getTimeout() -
setTimeout
public void setTimeout(org.elasticsearch.core.TimeValue timeout) How long to wait for job to open before timing out the request- Parameters:
timeout
- default value of 30 minutes
-
validate
- Specified by:
validate
in classActionRequest
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
toString
- Overrides:
toString
in classTransportRequest
-
hashCode
public int hashCode() -
equals
-