Class ForecastRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.ForecastRequest
- All Implemented Interfaces:
JsonpSerializable
Predicts the future behavior of a time series by using its historical
behavior. You can create a forecast job based on an anomaly detection job to
extrapolate future behavior. You can delete a forecast by using the Delete
forecast API.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<ForecastRequest>
Json deserializer forForecastRequest
static final Endpoint<ForecastRequest,
ForecastResponse, ErrorResponse> Endpoint "ml.forecast
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Time
duration()
A period of time that indicates how far into the future to forecast.final Time
The period of time that forecast results are retained.final String
jobId()
Required - Identifier for the anomaly detection job.final String
The maximum memory the forecast can use.static ForecastRequest
void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forForecastRequest
-
_ENDPOINT
Endpoint "ml.forecast
".
-
-
Method Details
-
of
public static ForecastRequest of(Function<ForecastRequest.Builder, ObjectBuilder<ForecastRequest>> fn) -
duration
A period of time that indicates how far into the future to forecast. For example,30d
corresponds to 30 days. The forecast starts at the last record that was processed.API name:
duration
-
expiresIn
The period of time that forecast results are retained. After a forecast expires, the results are deleted. If set to a value of 0, the forecast is never automatically deleted.API name:
expires_in
-
jobId
Required - Identifier for the anomaly detection job.API name:
job_id
-
maxModelMemory
The maximum memory the forecast can use. If the forecast needs to use more than the provided amount, it will spool to disk. Default is 20mb, maximum is 500mb and minimum is 1mb. If set to 40% or more of the job’s configured memory limit, it is automatically reduced to below that amount.API name:
max_model_memory
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupForecastRequestDeserializer
protected static void setupForecastRequestDeserializer(ObjectDeserializer<ForecastRequest.Builder> op)
-