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.core.RefCounted
,org.elasticsearch.tasks.TaskAwareRequest
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class ForecastJobRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.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
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
-
Field Summary
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ConstructingObjectParser<ForecastJobRequest,
Void> Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
org.elasticsearch.core.TimeValue
org.elasticsearch.core.TimeValue
getJobId()
org.elasticsearch.common.unit.ByteSizeValue
int
hashCode()
void
setDuration
(org.elasticsearch.core.TimeValue duration) Set the forecast duration A period of time that indicates how far into the future to forecast.void
setExpiresIn
(org.elasticsearch.core.TimeValue expiresIn) Set the forecast expiration The period of time that forecast results are retained.setMaxModelMemory
(org.elasticsearch.common.unit.ByteSizeValue maxModelMemory) Set the amount of memory allowed to be used by this forecast.org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) org.elasticsearch.action.ActionRequestValidationException
validate()
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, writeTo
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask, toString
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
-
DURATION
public static final org.elasticsearch.xcontent.ParseField DURATION -
EXPIRES_IN
public static final org.elasticsearch.xcontent.ParseField EXPIRES_IN -
MAX_MODEL_MEMORY
public static final org.elasticsearch.xcontent.ParseField MAX_MODEL_MEMORY -
PARSER
public static final org.elasticsearch.xcontent.ConstructingObjectParser<ForecastJobRequest,Void> PARSER
-
-
Constructor Details
-
ForecastJobRequest
A new forecast request- Parameters:
jobId
- the non-null, existing, and opened jobId to forecast
-
-
Method Details
-
getJobId
-
getDuration
public org.elasticsearch.core.TimeValue getDuration() -
setDuration
public void setDuration(org.elasticsearch.core.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.core.TimeValue getExpiresIn() -
setExpiresIn
public void setExpiresIn(org.elasticsearch.core.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
-
getMaxModelMemory
public org.elasticsearch.common.unit.ByteSizeValue getMaxModelMemory() -
setMaxModelMemory
public ForecastJobRequest setMaxModelMemory(org.elasticsearch.common.unit.ByteSizeValue maxModelMemory) Set the amount of memory allowed to be used by this forecast. If the projected forecast memory usage exceeds this amount, the forecast will spool results to disk to keep within the limits.- Parameters:
maxModelMemory
- A byte sized value less than 500MB and less than 40% of the associated job's configured memory usage. Defaults to 20MB.
-
hashCode
public int hashCode() -
equals
-
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
-
validate
public org.elasticsearch.action.ActionRequestValidationException validate()- Specified by:
validate
in classorg.elasticsearch.action.ActionRequest
-