Class ForecastRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.ForecastRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class ForecastRequest extends RequestBase implements 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:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ForecastRequest.Builder
Builder forForecastRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<ForecastRequest>
_DESERIALIZER
Json deserializer forForecastRequest
static Endpoint<ForecastRequest,ForecastResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.forecast
". -
Method Summary
Modifier and Type Method Description Time
duration()
Refer to the description for theduration
query parameter.Time
expiresIn()
Refer to the description for theexpires_in
query parameter.java.lang.String
jobId()
Required - Identifier for the anomaly detection job.java.lang.String
maxModelMemory()
Refer to the description for themax_model_memory
query parameter.static ForecastRequest
of(java.util.function.Function<ForecastRequest.Builder,ObjectBuilder<ForecastRequest>> fn)
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
setupForecastRequestDeserializer(ObjectDeserializer<ForecastRequest.Builder> op)
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forForecastRequest
-
_ENDPOINT
Endpoint "ml.forecast
".
-
-
Method Details
-
of
public static ForecastRequest of(java.util.function.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
public final java.lang.String 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
@Nullable public final java.lang.String 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)
-