Package co.elastic.clients.elasticsearch.ml

Class DeleteForecastRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<DeleteForecastRequest.Builder>

co.elastic.clients.elasticsearch.ml.DeleteForecastRequest.Builder

All Implemented Interfaces:

WithJson<DeleteForecastRequest.Builder>, ObjectBuilder<DeleteForecastRequest>

Enclosing class:

DeleteForecastRequest

public static class DeleteForecastRequest.Builder
extends RequestBase.AbstractBuilder<DeleteForecastRequest.Builder>
implements ObjectBuilder<DeleteForecastRequest>

Builder for DeleteForecastRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allowNoForecasts

public final DeleteForecastRequest.Builder allowNoForecasts(@Nullable
 Boolean value)

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

public final DeleteForecastRequest.Builder forecastId(@Nullable
 String value)

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 DeleteForecastRequest.Builder jobId(String value)

Required - Identifier for the anomaly detection job.

API name: job_id

timeout

public final DeleteForecastRequest.Builder timeout(@Nullable
 Time value)

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

timeout

public final DeleteForecastRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

self

protected DeleteForecastRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<DeleteForecastRequest.Builder>

build

public DeleteForecastRequest build()

Builds a DeleteForecastRequest.

Specified by:

build in interface ObjectBuilder<DeleteForecastRequest>

Throws:

NullPointerException - if some of the required fields are null.