Package co.elastic.clients.elasticsearch.ml

Class DeleteForecastRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.DeleteForecastRequest

public class DeleteForecastRequest
extends RequestBase

Delete forecasts from a job.

By default, forecasts are retained for 14 days. You can specify a different retention period with the expires_in parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeleteForecastRequest.Builder	Builder for DeleteForecastRequest.

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 final Endpoint<DeleteForecastRequest,DeleteForecastResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.delete_forecast".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoForecasts()	Specifies whether an error occurs when there are no forecasts.
final String	forecastId()	A comma-separated list of forecast identifiers.
final String	jobId()	Required - Identifier for the anomaly detection job.
static DeleteForecastRequest	of(Function<DeleteForecastRequest.Builder,ObjectBuilder<DeleteForecastRequest>> fn)
final Time	timeout()	Specifies the period of time to wait for the completion of the delete operation.

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

_ENDPOINT

public static final Endpoint<DeleteForecastRequest,DeleteForecastResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.delete_forecast".

Method Details

of

public static DeleteForecastRequest of(Function<DeleteForecastRequest.Builder,ObjectBuilder<DeleteForecastRequest>> fn)

allowNoForecasts

@Nullable
public final Boolean allowNoForecasts()

Specifies whether an error occurs when there are no forecasts. In particular, if this parameter is set to false and there are no forecasts associated with the job, attempts to delete all forecasts return an error.

API name: allow_no_forecasts

forecastId

@Nullable
public final String forecastId()

A comma-separated list of forecast identifiers. If you do not specify this optional parameter or if you specify _all or * the API deletes all forecasts from the job.

API name: forecast_id

jobId

public final String jobId()

Required - Identifier for the anomaly detection job.

API name: job_id

timeout

@Nullable
public final Time timeout()

Specifies the period of time to wait for the completion of the delete operation. When this period of time elapses, the API fails and returns an error.

API name: timeout