co.elastic.clients.elasticsearch.ml.StartDatafeedRequest 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.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 co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.String;
import java.util.Collections;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: ml.start_datafeed.Request
/**
* Starts one or more datafeeds.
*
* A datafeed must be started in order to retrieve data from Elasticsearch. A
* datafeed can be started and stopped multiple times throughout its lifecycle.
*
* Before you can start a datafeed, the anomaly detection job must be open.
* Otherwise, an error occurs.
*
* If you restart a stopped datafeed, it continues processing input data from
* the next millisecond after it was stopped. If new data was indexed for that
* exact millisecond between stopping and starting, it will be ignored.
*
* When Elasticsearch security features are enabled, your datafeed remembers
* which roles the last user to create or update it had at the time of creation
* or update and runs the query using those same roles. If you provided
* secondary authorization headers when you created or updated the datafeed,
* those credentials are used instead.
*
* @see API
* specification
*/
@JsonpDeserializable
public class StartDatafeedRequest extends RequestBase implements JsonpSerializable {
private final String datafeedId;
@Nullable
private final Time end;
@Nullable
private final Time start;
@Nullable
private final Time timeout;
// ---------------------------------------------------------------------------------------------
private StartDatafeedRequest(Builder builder) {
this.datafeedId = ApiTypeHelper.requireNonNull(builder.datafeedId, this, "datafeedId");
this.end = builder.end;
this.start = builder.start;
this.timeout = builder.timeout;
}
public static StartDatafeedRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - A numerical character string that uniquely identifies the
* datafeed. 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 datafeed_id}
*/
public final String datafeedId() {
return this.datafeedId;
}
/**
* Refer to the description for the end query parameter.
*
* API name: {@code end}
*/
@Nullable
public final Time end() {
return this.end;
}
/**
* Refer to the description for the start query parameter.
*
* API name: {@code start}
*/
@Nullable
public final Time start() {
return this.start;
}
/**
* 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.end != null) {
generator.writeKey("end");
this.end.serialize(generator, mapper);
}
if (this.start != null) {
generator.writeKey("start");
this.start.serialize(generator, mapper);
}
if (this.timeout != null) {
generator.writeKey("timeout");
this.timeout.serialize(generator, mapper);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link StartDatafeedRequest}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
private String datafeedId;
@Nullable
private Time end;
@Nullable
private Time start;
@Nullable
private Time timeout;
/**
* Required - A numerical character string that uniquely identifies the
* datafeed. 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 datafeed_id}
*/
public final Builder datafeedId(String value) {
this.datafeedId = value;
return this;
}
/**
* Refer to the description for the end query parameter.
*
* API name: {@code end}
*/
public final Builder end(@Nullable Time value) {
this.end = value;
return this;
}
/**
* Refer to the description for the end query parameter.
*
* API name: {@code end}
*/
public final Builder end(Function> fn) {
return this.end(fn.apply(new Time.Builder()).build());
}
/**
* Refer to the description for the start query parameter.
*
* API name: {@code start}
*/
public final Builder start(@Nullable Time value) {
this.start = value;
return this;
}
/**
* Refer to the description for the start query parameter.
*
* API name: {@code start}
*/
public final Builder start(Function> fn) {
return this.start(fn.apply(new Time.Builder()).build());
}
/**
* 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 StartDatafeedRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public StartDatafeedRequest build() {
_checkSingleUse();
return new StartDatafeedRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link StartDatafeedRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, StartDatafeedRequest::setupStartDatafeedRequestDeserializer);
protected static void setupStartDatafeedRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::end, Time._DESERIALIZER, "end");
op.add(Builder::start, Time._DESERIALIZER, "start");
op.add(Builder::timeout, Time._DESERIALIZER, "timeout");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ml.start_datafeed}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ml.start_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("/_start");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
return Collections.emptyMap();
}, SimpleEndpoint.emptyMap(), true, StartDatafeedResponse._DESERIALIZER);
}