co.elastic.clients.elasticsearch.ml.DeleteForecastRequest Maven / Gradle / Ivy
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.ml;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.Time;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.String;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: ml.delete_forecast.Request
/**
* Deletes forecasts from a machine learning 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 API
* specification
*/
public class DeleteForecastRequest extends RequestBase {
@Nullable
private final Boolean allowNoForecasts;
@Nullable
private final String forecastId;
private final String jobId;
@Nullable
private final Time timeout;
// ---------------------------------------------------------------------------------------------
private DeleteForecastRequest(Builder builder) {
this.allowNoForecasts = builder.allowNoForecasts;
this.forecastId = builder.forecastId;
this.jobId = ApiTypeHelper.requireNonNull(builder.jobId, this, "jobId");
this.timeout = builder.timeout;
}
public static DeleteForecastRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* 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: {@code allow_no_forecasts}
*/
@Nullable
public final Boolean allowNoForecasts() {
return this.allowNoForecasts;
}
/**
* 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: {@code forecast_id}
*/
@Nullable
public final String forecastId() {
return this.forecastId;
}
/**
* Required - Identifier for the anomaly detection job.
*
* API name: {@code job_id}
*/
public final String jobId() {
return this.jobId;
}
/**
* 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: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DeleteForecastRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Boolean allowNoForecasts;
@Nullable
private String forecastId;
private String jobId;
@Nullable
private Time timeout;
/**
* 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: {@code allow_no_forecasts}
*/
public final Builder allowNoForecasts(@Nullable Boolean value) {
this.allowNoForecasts = value;
return this;
}
/**
* 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: {@code forecast_id}
*/
public final Builder forecastId(@Nullable String value) {
this.forecastId = value;
return this;
}
/**
* Required - Identifier for the anomaly detection job.
*
* API name: {@code job_id}
*/
public final Builder jobId(String value) {
this.jobId = value;
return this;
}
/**
* 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: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* 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: {@code timeout}
*/
public final Builder timeout(Function> fn) {
return this.timeout(fn.apply(new Time.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link DeleteForecastRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DeleteForecastRequest build() {
_checkSingleUse();
return new DeleteForecastRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ml.delete_forecast}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ml.delete_forecast",
// Request method
request -> {
return "DELETE";
},
// Request path
request -> {
final int _jobId = 1 << 0;
final int _forecastId = 1 << 1;
int propsSet = 0;
propsSet |= _jobId;
if (request.forecastId() != null)
propsSet |= _forecastId;
if (propsSet == (_jobId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/anomaly_detectors");
buf.append("/");
SimpleEndpoint.pathEncode(request.jobId, buf);
buf.append("/_forecast");
return buf.toString();
}
if (propsSet == (_jobId | _forecastId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/anomaly_detectors");
buf.append("/");
SimpleEndpoint.pathEncode(request.jobId, buf);
buf.append("/_forecast");
buf.append("/");
SimpleEndpoint.pathEncode(request.forecastId, buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _jobId = 1 << 0;
final int _forecastId = 1 << 1;
int propsSet = 0;
propsSet |= _jobId;
if (request.forecastId() != null)
propsSet |= _forecastId;
if (propsSet == (_jobId)) {
params.put("jobId", request.jobId);
}
if (propsSet == (_jobId | _forecastId)) {
params.put("jobId", request.jobId);
params.put("forecastId", request.forecastId);
}
return params;
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.allowNoForecasts != null) {
params.put("allow_no_forecasts", String.valueOf(request.allowNoForecasts));
}
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
return params;
}, SimpleEndpoint.emptyMap(), false, DeleteForecastResponse._DESERIALIZER);
}