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.
Forecasts are not supported for jobs that perform population analysis; an
error occurs if you try to create a forecast for a job that has an
over_field_name
in its configuration.
- 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()
Refer to the description for theduration
query parameter.final Time
Refer to the description for theexpires_in
query parameter.final String
jobId()
Required - Identifier for the anomaly detection job.final String
Refer to the description for themax_model_memory
query parameter.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
Refer to the description for theduration
query parameter.API name:
duration
-
expiresIn
Refer to the description for theexpires_in
query parameter.API name:
expires_in
-
jobId
Required - Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs.API name:
job_id
-
maxModelMemory
Refer to the description for themax_model_memory
query parameter.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)
-