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:
org.elasticsearch.common.io.stream.Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,org.elasticsearch.tasks.TaskAwareRequest
public class ForecastJobRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.common.xcontent.ToXContentObject
Pojo for forecasting an existing and open Machine Learning Job
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
org.elasticsearch.transport.TransportRequest.Empty
-
Field Summary
Fields Modifier and Type Field Description static org.elasticsearch.common.ParseField
DURATION
static org.elasticsearch.common.ParseField
EXPIRES_IN
static org.elasticsearch.common.xcontent.ConstructingObjectParser<ForecastJobRequest,java.lang.Void>
PARSER
-
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)
org.elasticsearch.common.unit.TimeValue
getDuration()
org.elasticsearch.common.unit.TimeValue
getExpiresIn()
java.lang.String
getJobId()
int
hashCode()
void
setDuration(org.elasticsearch.common.unit.TimeValue duration)
Set the forecast duration A period of time that indicates how far into the future to forecast.void
setExpiresIn(org.elasticsearch.common.unit.TimeValue expiresIn)
Set the forecast expiration The period of time that forecast results are retained.org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
org.elasticsearch.action.ActionRequestValidationException
validate()
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
-
Field Details
-
DURATION
public static final org.elasticsearch.common.ParseField DURATION -
EXPIRES_IN
public static final org.elasticsearch.common.ParseField EXPIRES_IN -
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<ForecastJobRequest,java.lang.Void> PARSER
-
-
Constructor Details
-
ForecastJobRequest
public ForecastJobRequest(java.lang.String jobId)A new forecast request- Parameters:
jobId
- the non-null, existing, and opened jobId to forecast
-
-
Method Details
-
getJobId
public java.lang.String getJobId() -
getDuration
public org.elasticsearch.common.unit.TimeValue getDuration() -
setDuration
public void setDuration(org.elasticsearch.common.unit.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 org.elasticsearch.common.unit.TimeValue getExpiresIn() -
setExpiresIn
public void setExpiresIn(org.elasticsearch.common.unit.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 org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-
validate
public org.elasticsearch.action.ActionRequestValidationException validate()- Specified by:
validate
in classorg.elasticsearch.action.ActionRequest
-