Package org.elasticsearch.client.ml
Class ForecastJobRequest
- java.lang.Object
-
- org.elasticsearch.transport.TransportMessage
-
- org.elasticsearch.transport.TransportRequest
-
- org.elasticsearch.action.ActionRequest
-
- org.elasticsearch.client.ml.ForecastJobRequest
-
- All Implemented Interfaces:
Streamable
,Writeable
,ToXContent
,ToXContentObject
,TaskAwareRequest
public class ForecastJobRequest extends ActionRequest implements ToXContentObject
Pojo for forecasting an existing and open 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 ParseField
DURATION
static ParseField
EXPIRES_IN
static ConstructingObjectParser<ForecastJobRequest,java.lang.Void>
PARSER
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description ForecastJobRequest(java.lang.String jobId)
A new forecast request
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object obj)
TimeValue
getDuration()
TimeValue
getExpiresIn()
java.lang.String
getJobId()
int
hashCode()
void
setDuration(TimeValue duration)
Set the forecast duration A period of time that indicates how far into the future to forecast.void
setExpiresIn(TimeValue expiresIn)
Set the forecast expiration The period of time that forecast results are retained.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, toString, 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
-
DURATION
public static final ParseField DURATION
-
EXPIRES_IN
public static final ParseField EXPIRES_IN
-
PARSER
public static final ConstructingObjectParser<ForecastJobRequest,java.lang.Void> PARSER
-
-
Method Detail
-
getJobId
public java.lang.String getJobId()
-
getDuration
public TimeValue getDuration()
-
setDuration
public void setDuration(TimeValue duration)
Set the forecast duration A period of time that indicates how far into the future to forecast. The default value is 1 day. The forecast starts at the last record that was processed.- Parameters:
duration
- TimeValue for the duration of the forecast
-
getExpiresIn
public TimeValue getExpiresIn()
-
setExpiresIn
public void setExpiresIn(TimeValue expiresIn)
Set the forecast expiration The period of time that forecast results are retained. After a forecast expires, the results are deleted. The default value is 14 days. If set to a value of 0, the forecast is never automatically deleted.- Parameters:
expiresIn
- TimeValue for the forecast expiration
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
validate
public ActionRequestValidationException validate()
- Specified by:
validate
in classActionRequest
-
-