co.elastic.clients.elasticsearch.ml.StartDataFrameAnalyticsRequest 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.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.start_data_frame_analytics.Request
/**
* Start a data frame analytics job. A data frame analytics job can be started
* and stopped multiple times throughout its lifecycle. If the destination index
* does not exist, it is created automatically the first time you start the data
* frame analytics job. The index.number_of_shards and
* index.number_of_replicas settings for the destination index are
* copied from the source index. If there are multiple source indices, the
* destination index copies the highest setting values. The mappings for the
* destination index are also copied from the source indices. If there are any
* mapping conflicts, the job fails to start. If the destination index exists,
* it is used as is. You can therefore set up the destination index in advance
* with custom settings and mappings.
*
* @see API
* specification
*/
public class StartDataFrameAnalyticsRequest extends RequestBase {
private final String id;
@Nullable
private final Time timeout;
// ---------------------------------------------------------------------------------------------
private StartDataFrameAnalyticsRequest(Builder builder) {
this.id = ApiTypeHelper.requireNonNull(builder.id, this, "id");
this.timeout = builder.timeout;
}
public static StartDataFrameAnalyticsRequest of(
Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - Identifier for the data frame analytics job. This identifier can
* contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
* underscores. It must start and end with alphanumeric characters.
*
* API name: {@code id}
*/
public final String id() {
return this.id;
}
/**
* Controls the amount of time to wait until the data frame analytics job
* starts.
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link StartDataFrameAnalyticsRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
private String id;
@Nullable
private Time timeout;
/**
* Required - Identifier for the data frame analytics job. This identifier can
* contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
* underscores. It must start and end with alphanumeric characters.
*
* API name: {@code id}
*/
public final Builder id(String value) {
this.id = value;
return this;
}
/**
* Controls the amount of time to wait until the data frame analytics job
* starts.
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* Controls the amount of time to wait until the data frame analytics job
* starts.
*
* 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 StartDataFrameAnalyticsRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public StartDataFrameAnalyticsRequest build() {
_checkSingleUse();
return new StartDataFrameAnalyticsRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ml.start_data_frame_analytics}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ml.start_data_frame_analytics",
// Request method
request -> {
return "POST";
},
// 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);
buf.append("/_start");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _id = 1 << 0;
int propsSet = 0;
propsSet |= _id;
if (propsSet == (_id)) {
params.put("id", request.id);
}
return params;
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
return params;
}, SimpleEndpoint.emptyMap(), false, StartDataFrameAnalyticsResponse._DESERIALIZER);
}