co.elastic.clients.elasticsearch.ml.StopDatafeedRequest 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.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
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.Collections;
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.stop_datafeed.Request
/**
* Stop datafeeds. A datafeed that is stopped ceases to retrieve data from
* Elasticsearch. A datafeed can be started and stopped multiple times
* throughout its lifecycle.
*
* @see API
* specification
*/
@JsonpDeserializable
public class StopDatafeedRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final Boolean allowNoMatch;
private final String datafeedId;
@Nullable
private final Boolean force;
@Nullable
private final Time timeout;
// ---------------------------------------------------------------------------------------------
private StopDatafeedRequest(Builder builder) {
this.allowNoMatch = builder.allowNoMatch;
this.datafeedId = ApiTypeHelper.requireNonNull(builder.datafeedId, this, "datafeedId");
this.force = builder.force;
this.timeout = builder.timeout;
}
public static StopDatafeedRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Refer to the description for the allow_no_match query parameter.
*
* API name: {@code allow_no_match}
*/
@Nullable
public final Boolean allowNoMatch() {
return this.allowNoMatch;
}
/**
* Required - Identifier for the datafeed. You can stop multiple datafeeds in a
* single API request by using a comma-separated list of datafeeds or a wildcard
* expression. You can close all datafeeds by using _all or by
* specifying * as the identifier.
*
* API name: {@code datafeed_id}
*/
public final String datafeedId() {
return this.datafeedId;
}
/**
* Refer to the description for the force query parameter.
*
* API name: {@code force}
*/
@Nullable
public final Boolean force() {
return this.force;
}
/**
* Refer to the description for the timeout query parameter.
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (this.allowNoMatch != null) {
generator.writeKey("allow_no_match");
generator.write(this.allowNoMatch);
}
if (this.force != null) {
generator.writeKey("force");
generator.write(this.force);
}
if (this.timeout != null) {
generator.writeKey("timeout");
this.timeout.serialize(generator, mapper);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link StopDatafeedRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Boolean allowNoMatch;
private String datafeedId;
@Nullable
private Boolean force;
@Nullable
private Time timeout;
/**
* Refer to the description for the allow_no_match query parameter.
*
* API name: {@code allow_no_match}
*/
public final Builder allowNoMatch(@Nullable Boolean value) {
this.allowNoMatch = value;
return this;
}
/**
* Required - Identifier for the datafeed. You can stop multiple datafeeds in a
* single API request by using a comma-separated list of datafeeds or a wildcard
* expression. You can close all datafeeds by using _all or by
* specifying * as the identifier.
*
* API name: {@code datafeed_id}
*/
public final Builder datafeedId(String value) {
this.datafeedId = value;
return this;
}
/**
* Refer to the description for the force query parameter.
*
* API name: {@code force}
*/
public final Builder force(@Nullable Boolean value) {
this.force = value;
return this;
}
/**
* Refer to the description for the timeout query parameter.
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* Refer to the description for the timeout query parameter.
*
* 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 StopDatafeedRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public StopDatafeedRequest build() {
_checkSingleUse();
return new StopDatafeedRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link StopDatafeedRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, StopDatafeedRequest::setupStopDatafeedRequestDeserializer);
protected static void setupStopDatafeedRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::allowNoMatch, JsonpDeserializer.booleanDeserializer(), "allow_no_match");
op.add(Builder::force, JsonpDeserializer.booleanDeserializer(), "force");
op.add(Builder::timeout, Time._DESERIALIZER, "timeout");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ml.stop_datafeed}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ml.stop_datafeed",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
final int _datafeedId = 1 << 0;
int propsSet = 0;
propsSet |= _datafeedId;
if (propsSet == (_datafeedId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/datafeeds");
buf.append("/");
SimpleEndpoint.pathEncode(request.datafeedId, buf);
buf.append("/_stop");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _datafeedId = 1 << 0;
int propsSet = 0;
propsSet |= _datafeedId;
if (propsSet == (_datafeedId)) {
params.put("datafeedId", request.datafeedId);
}
return params;
},
// Request parameters
request -> {
return Collections.emptyMap();
}, SimpleEndpoint.emptyMap(), true, StopDatafeedResponse._DESERIALIZER);
}