co.elastic.clients.elasticsearch.ml.DeleteDataFrameAnalyticsRequest Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* 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.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
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 co.elastic.clients.util.ObjectBuilderBase;
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;
// typedef: ml.delete_data_frame_analytics.Request
/**
* Deletes a data frame analytics job.
*
* @see API
* specification
*/
public class DeleteDataFrameAnalyticsRequest extends RequestBase {
@Nullable
private final Boolean force;
private final String id;
@Nullable
private final Time timeout;
// ---------------------------------------------------------------------------------------------
private DeleteDataFrameAnalyticsRequest(Builder builder) {
this.force = builder.force;
this.id = ApiTypeHelper.requireNonNull(builder.id, this, "id");
this.timeout = builder.timeout;
}
public static DeleteDataFrameAnalyticsRequest of(
Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* If true, it deletes a job that is not stopped; this method is
* quicker than stopping and deleting the job.
*
* API name: {@code force}
*/
@Nullable
public final Boolean force() {
return this.force;
}
/**
* Required - Identifier for the data frame analytics job.
*
* API name: {@code id}
*/
public final String id() {
return this.id;
}
/**
* The time to wait for the job to be deleted.
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DeleteDataFrameAnalyticsRequest}.
*/
public static class Builder extends ObjectBuilderBase implements ObjectBuilder {
@Nullable
private Boolean force;
private String id;
@Nullable
private Time timeout;
/**
* If true, it deletes a job that is not stopped; this method is
* quicker than stopping and deleting the job.
*
* API name: {@code force}
*/
public final Builder force(@Nullable Boolean value) {
this.force = value;
return this;
}
/**
* Required - Identifier for the data frame analytics job.
*
* API name: {@code id}
*/
public final Builder id(String value) {
this.id = value;
return this;
}
/**
* The time to wait for the job to be deleted.
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* The time to wait for the job to be deleted.
*
* API name: {@code timeout}
*/
public final Builder timeout(Function> fn) {
return this.timeout(fn.apply(new Time.Builder()).build());
}
/**
* Builds a {@link DeleteDataFrameAnalyticsRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DeleteDataFrameAnalyticsRequest build() {
_checkSingleUse();
return new DeleteDataFrameAnalyticsRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ml.delete_data_frame_analytics}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ml.delete_data_frame_analytics",
// Request method
request -> {
return "DELETE";
},
// Request path
request -> {
final int _id = 1 << 0;
int propsSet = 0;
propsSet |= _id;
if (propsSet == (_id)) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/data_frame");
buf.append("/analytics");
buf.append("/");
SimpleEndpoint.pathEncode(request.id, buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.force != null) {
params.put("force", String.valueOf(request.force));
}
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
return params;
}, SimpleEndpoint.emptyMap(), false, DeleteDataFrameAnalyticsResponse._DESERIALIZER);
}