co.elastic.clients.elasticsearch.ml.UpdateDatafeedRequest 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.
*/
package co.elastic.clients.elasticsearch.ml;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.ExpandWildcard;
import co.elastic.clients.elasticsearch._types.IndicesOptions;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.ScriptField;
import co.elastic.clients.elasticsearch._types.Time;
import co.elastic.clients.elasticsearch._types.aggregations.Aggregation;
import co.elastic.clients.elasticsearch._types.mapping.RuntimeField;
import co.elastic.clients.elasticsearch._types.query_dsl.Query;
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.Integer;
import java.lang.String;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import java.util.stream.Collectors;
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.update_datafeed.Request
/**
* Update a datafeed. You must stop and start the datafeed for the changes to be
* applied. When Elasticsearch security features are enabled, your datafeed
* remembers which roles the user who updated it had at the time of the update
* and runs the query using those same roles. If you provide secondary
* authorization headers, those credentials are used instead.
*
* @see API
* specification
*/
@JsonpDeserializable
public class UpdateDatafeedRequest extends RequestBase implements JsonpSerializable {
private final Map aggregations;
@Nullable
private final Boolean allowNoIndices;
@Nullable
private final ChunkingConfig chunkingConfig;
private final String datafeedId;
@Nullable
private final DelayedDataCheckConfig delayedDataCheckConfig;
private final List expandWildcards;
@Nullable
private final Time frequency;
@Nullable
private final Boolean ignoreThrottled;
@Nullable
private final Boolean ignoreUnavailable;
private final List indices;
@Nullable
private final IndicesOptions indicesOptions;
@Nullable
private final String jobId;
@Nullable
private final Integer maxEmptySearches;
@Nullable
private final Query query;
@Nullable
private final Time queryDelay;
private final Map runtimeMappings;
private final Map scriptFields;
@Nullable
private final Integer scrollSize;
// ---------------------------------------------------------------------------------------------
private UpdateDatafeedRequest(Builder builder) {
this.aggregations = ApiTypeHelper.unmodifiable(builder.aggregations);
this.allowNoIndices = builder.allowNoIndices;
this.chunkingConfig = builder.chunkingConfig;
this.datafeedId = ApiTypeHelper.requireNonNull(builder.datafeedId, this, "datafeedId");
this.delayedDataCheckConfig = builder.delayedDataCheckConfig;
this.expandWildcards = ApiTypeHelper.unmodifiable(builder.expandWildcards);
this.frequency = builder.frequency;
this.ignoreThrottled = builder.ignoreThrottled;
this.ignoreUnavailable = builder.ignoreUnavailable;
this.indices = ApiTypeHelper.unmodifiable(builder.indices);
this.indicesOptions = builder.indicesOptions;
this.jobId = builder.jobId;
this.maxEmptySearches = builder.maxEmptySearches;
this.query = builder.query;
this.queryDelay = builder.queryDelay;
this.runtimeMappings = ApiTypeHelper.unmodifiable(builder.runtimeMappings);
this.scriptFields = ApiTypeHelper.unmodifiable(builder.scriptFields);
this.scrollSize = builder.scrollSize;
}
public static UpdateDatafeedRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* If set, the datafeed performs aggregation searches. Support for aggregations
* is limited and should be used only with low cardinality data.
*
* API name: {@code aggregations}
*/
public final Map aggregations() {
return this.aggregations;
}
/**
* If true, wildcard indices expressions that resolve into no
* concrete indices are ignored. This includes the _all string or
* when no indices are specified.
*
* API name: {@code allow_no_indices}
*/
@Nullable
public final Boolean allowNoIndices() {
return this.allowNoIndices;
}
/**
* Datafeeds might search over long time periods, for several months or years.
* This search is split into time chunks in order to ensure the load on
* Elasticsearch is managed. Chunking configuration controls how the size of
* these time chunks are calculated; it is an advanced configuration option.
*
* API name: {@code chunking_config}
*/
@Nullable
public final ChunkingConfig chunkingConfig() {
return this.chunkingConfig;
}
/**
* 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;
}
/**
* Specifies whether the datafeed checks for missing data and the size of the
* window. The datafeed can optionally search over indices that have already
* been read in an effort to determine whether any data has subsequently been
* added to the index. If missing data is found, it is a good indication that
* the query_delay is set too low and the data is being indexed
* after the datafeed has passed that moment in time. This check runs only on
* real-time datafeeds.
*
* API name: {@code delayed_data_check_config}
*/
@Nullable
public final DelayedDataCheckConfig delayedDataCheckConfig() {
return this.delayedDataCheckConfig;
}
/**
* Type of index that wildcard patterns can match. If the request can target
* data streams, this argument determines whether wildcard expressions match
* hidden data streams. Supports comma-separated values. Valid values are:
*
* all: Match any data stream or index, including hidden
* ones.closed: Match closed, non-hidden indices. Also matches any
* non-hidden data stream. Data streams cannot be closed.hidden: Match hidden data streams and hidden indices. Must
* be combined with open, closed, or both.none: Wildcard patterns are not accepted.open: Match open, non-hidden indices. Also matches any
* non-hidden data stream.
*
* API name: {@code expand_wildcards}
*/
public final List expandWildcards() {
return this.expandWildcards;
}
/**
* The interval at which scheduled queries are made while the datafeed runs in
* real time. The default value is either the bucket span for short bucket
* spans, or, for longer bucket spans, a sensible fraction of the bucket span.
* When frequency is shorter than the bucket span, interim results
* for the last (partial) bucket are written then eventually overwritten by the
* full bucket results. If the datafeed uses aggregations, this value must be
* divisible by the interval of the date histogram aggregation.
*
* API name: {@code frequency}
*/
@Nullable
public final Time frequency() {
return this.frequency;
}
/**
* If true, concrete, expanded or aliased indices are ignored when
* frozen.
*
* API name: {@code ignore_throttled}
*
* @deprecated 7.16.0
*/
@Deprecated
@Nullable
public final Boolean ignoreThrottled() {
return this.ignoreThrottled;
}
/**
* If true, unavailable indices (missing or closed) are ignored.
*
* API name: {@code ignore_unavailable}
*/
@Nullable
public final Boolean ignoreUnavailable() {
return this.ignoreUnavailable;
}
/**
* An array of index names. Wildcards are supported. If any of the indices are
* in remote clusters, the machine learning nodes must have the
* remote_cluster_client role.
*
* API name: {@code indices}
*/
public final List indices() {
return this.indices;
}
/**
* Specifies index expansion options that are used during search.
*
* API name: {@code indices_options}
*/
@Nullable
public final IndicesOptions indicesOptions() {
return this.indicesOptions;
}
/**
* API name: {@code job_id}
*/
@Nullable
public final String jobId() {
return this.jobId;
}
/**
* If a real-time datafeed has never seen any data (including during any initial
* training period), it automatically stops and closes the associated job after
* this many real-time searches return no documents. In other words, it stops
* after frequency times max_empty_searches of
* real-time operation. If not set, a datafeed with no end time that sees no
* data remains started until it is explicitly stopped. By default, it is not
* set.
*
* API name: {@code max_empty_searches}
*/
@Nullable
public final Integer maxEmptySearches() {
return this.maxEmptySearches;
}
/**
* The Elasticsearch query domain-specific language (DSL). This value
* corresponds to the query object in an Elasticsearch search POST body. All the
* options that are supported by Elasticsearch can be used, as this object is
* passed verbatim to Elasticsearch. Note that if you change the query, the
* analyzed data is also changed. Therefore, the time required to learn might be
* long and the understandability of the results is unpredictable. If you want
* to make significant changes to the source data, it is recommended that you
* clone the job and datafeed and make the amendments in the clone. Let both run
* in parallel and close one when you are satisfied with the results of the job.
*
* API name: {@code query}
*/
@Nullable
public final Query query() {
return this.query;
}
/**
* The number of seconds behind real time that data is queried. For example, if
* data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06
* a.m., set this property to 120 seconds. The default value is randomly
* selected between 60s and 120s. This randomness
* improves the query performance when there are multiple jobs running on the
* same node.
*
* API name: {@code query_delay}
*/
@Nullable
public final Time queryDelay() {
return this.queryDelay;
}
/**
* Specifies runtime fields for the datafeed search.
*
* API name: {@code runtime_mappings}
*/
public final Map runtimeMappings() {
return this.runtimeMappings;
}
/**
* Specifies scripts that evaluate custom expressions and returns script fields
* to the datafeed. The detector configuration objects in a job can contain
* functions that use these script fields.
*
* API name: {@code script_fields}
*/
public final Map scriptFields() {
return this.scriptFields;
}
/**
* The size parameter that is used in Elasticsearch searches when the datafeed
* does not use aggregations. The maximum value is the value of
* index.max_result_window.
*
* API name: {@code scroll_size}
*/
@Nullable
public final Integer scrollSize() {
return this.scrollSize;
}
/**
* 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 (ApiTypeHelper.isDefined(this.aggregations)) {
generator.writeKey("aggregations");
generator.writeStartObject();
for (Map.Entry item0 : this.aggregations.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.chunkingConfig != null) {
generator.writeKey("chunking_config");
this.chunkingConfig.serialize(generator, mapper);
}
if (this.delayedDataCheckConfig != null) {
generator.writeKey("delayed_data_check_config");
this.delayedDataCheckConfig.serialize(generator, mapper);
}
if (this.frequency != null) {
generator.writeKey("frequency");
this.frequency.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.indices)) {
generator.writeKey("indices");
generator.writeStartArray();
for (String item0 : this.indices) {
generator.write(item0);
}
generator.writeEnd();
}
if (this.indicesOptions != null) {
generator.writeKey("indices_options");
this.indicesOptions.serialize(generator, mapper);
}
if (this.jobId != null) {
generator.writeKey("job_id");
generator.write(this.jobId);
}
if (this.maxEmptySearches != null) {
generator.writeKey("max_empty_searches");
generator.write(this.maxEmptySearches);
}
if (this.query != null) {
generator.writeKey("query");
this.query.serialize(generator, mapper);
}
if (this.queryDelay != null) {
generator.writeKey("query_delay");
this.queryDelay.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.runtimeMappings)) {
generator.writeKey("runtime_mappings");
generator.writeStartObject();
for (Map.Entry item0 : this.runtimeMappings.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.scriptFields)) {
generator.writeKey("script_fields");
generator.writeStartObject();
for (Map.Entry item0 : this.scriptFields.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.scrollSize != null) {
generator.writeKey("scroll_size");
generator.write(this.scrollSize);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link UpdateDatafeedRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Map aggregations;
@Nullable
private Boolean allowNoIndices;
@Nullable
private ChunkingConfig chunkingConfig;
private String datafeedId;
@Nullable
private DelayedDataCheckConfig delayedDataCheckConfig;
@Nullable
private List expandWildcards;
@Nullable
private Time frequency;
@Nullable
private Boolean ignoreThrottled;
@Nullable
private Boolean ignoreUnavailable;
@Nullable
private List indices;
@Nullable
private IndicesOptions indicesOptions;
@Nullable
private String jobId;
@Nullable
private Integer maxEmptySearches;
@Nullable
private Query query;
@Nullable
private Time queryDelay;
@Nullable
private Map runtimeMappings;
@Nullable
private Map scriptFields;
@Nullable
private Integer scrollSize;
/**
* If set, the datafeed performs aggregation searches. Support for aggregations
* is limited and should be used only with low cardinality data.
*
* API name: {@code aggregations}
*
* Adds all entries of map to aggregations.
*/
public final Builder aggregations(Map map) {
this.aggregations = _mapPutAll(this.aggregations, map);
return this;
}
/**
* If set, the datafeed performs aggregation searches. Support for aggregations
* is limited and should be used only with low cardinality data.
*
* API name: {@code aggregations}
*
* Adds an entry to aggregations.
*/
public final Builder aggregations(String key, Aggregation value) {
this.aggregations = _mapPut(this.aggregations, key, value);
return this;
}
/**
* If set, the datafeed performs aggregation searches. Support for aggregations
* is limited and should be used only with low cardinality data.
*
* API name: {@code aggregations}
*
* Adds an entry to aggregations using a builder lambda.
*/
public final Builder aggregations(String key, Function> fn) {
return aggregations(key, fn.apply(new Aggregation.Builder()).build());
}
/**
* If true, wildcard indices expressions that resolve into no
* concrete indices are ignored. This includes the _all string or
* when no indices are specified.
*
* API name: {@code allow_no_indices}
*/
public final Builder allowNoIndices(@Nullable Boolean value) {
this.allowNoIndices = value;
return this;
}
/**
* Datafeeds might search over long time periods, for several months or years.
* This search is split into time chunks in order to ensure the load on
* Elasticsearch is managed. Chunking configuration controls how the size of
* these time chunks are calculated; it is an advanced configuration option.
*
* API name: {@code chunking_config}
*/
public final Builder chunkingConfig(@Nullable ChunkingConfig value) {
this.chunkingConfig = value;
return this;
}
/**
* Datafeeds might search over long time periods, for several months or years.
* This search is split into time chunks in order to ensure the load on
* Elasticsearch is managed. Chunking configuration controls how the size of
* these time chunks are calculated; it is an advanced configuration option.
*
* API name: {@code chunking_config}
*/
public final Builder chunkingConfig(Function> fn) {
return this.chunkingConfig(fn.apply(new ChunkingConfig.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 Builder datafeedId(String value) {
this.datafeedId = value;
return this;
}
/**
* Specifies whether the datafeed checks for missing data and the size of the
* window. The datafeed can optionally search over indices that have already
* been read in an effort to determine whether any data has subsequently been
* added to the index. If missing data is found, it is a good indication that
* the query_delay is set too low and the data is being indexed
* after the datafeed has passed that moment in time. This check runs only on
* real-time datafeeds.
*
* API name: {@code delayed_data_check_config}
*/
public final Builder delayedDataCheckConfig(@Nullable DelayedDataCheckConfig value) {
this.delayedDataCheckConfig = value;
return this;
}
/**
* Specifies whether the datafeed checks for missing data and the size of the
* window. The datafeed can optionally search over indices that have already
* been read in an effort to determine whether any data has subsequently been
* added to the index. If missing data is found, it is a good indication that
* the query_delay is set too low and the data is being indexed
* after the datafeed has passed that moment in time. This check runs only on
* real-time datafeeds.
*
* API name: {@code delayed_data_check_config}
*/
public final Builder delayedDataCheckConfig(
Function> fn) {
return this.delayedDataCheckConfig(fn.apply(new DelayedDataCheckConfig.Builder()).build());
}
/**
* Type of index that wildcard patterns can match. If the request can target
* data streams, this argument determines whether wildcard expressions match
* hidden data streams. Supports comma-separated values. Valid values are:
*
* all: Match any data stream or index, including hidden
* ones.closed: Match closed, non-hidden indices. Also matches any
* non-hidden data stream. Data streams cannot be closed.hidden: Match hidden data streams and hidden indices. Must
* be combined with open, closed, or both.none: Wildcard patterns are not accepted.open: Match open, non-hidden indices. Also matches any
* non-hidden data stream.
*
* API name: {@code expand_wildcards}
*
* Adds all elements of list to expandWildcards.
*/
public final Builder expandWildcards(List list) {
this.expandWildcards = _listAddAll(this.expandWildcards, list);
return this;
}
/**
* Type of index that wildcard patterns can match. If the request can target
* data streams, this argument determines whether wildcard expressions match
* hidden data streams. Supports comma-separated values. Valid values are:
*
* all: Match any data stream or index, including hidden
* ones.closed: Match closed, non-hidden indices. Also matches any
* non-hidden data stream. Data streams cannot be closed.hidden: Match hidden data streams and hidden indices. Must
* be combined with open, closed, or both.none: Wildcard patterns are not accepted.open: Match open, non-hidden indices. Also matches any
* non-hidden data stream.
*
* API name: {@code expand_wildcards}
*
* Adds one or more values to expandWildcards.
*/
public final Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) {
this.expandWildcards = _listAdd(this.expandWildcards, value, values);
return this;
}
/**
* The interval at which scheduled queries are made while the datafeed runs in
* real time. The default value is either the bucket span for short bucket
* spans, or, for longer bucket spans, a sensible fraction of the bucket span.
* When frequency is shorter than the bucket span, interim results
* for the last (partial) bucket are written then eventually overwritten by the
* full bucket results. If the datafeed uses aggregations, this value must be
* divisible by the interval of the date histogram aggregation.
*
* API name: {@code frequency}
*/
public final Builder frequency(@Nullable Time value) {
this.frequency = value;
return this;
}
/**
* The interval at which scheduled queries are made while the datafeed runs in
* real time. The default value is either the bucket span for short bucket
* spans, or, for longer bucket spans, a sensible fraction of the bucket span.
* When frequency is shorter than the bucket span, interim results
* for the last (partial) bucket are written then eventually overwritten by the
* full bucket results. If the datafeed uses aggregations, this value must be
* divisible by the interval of the date histogram aggregation.
*
* API name: {@code frequency}
*/
public final Builder frequency(Function> fn) {
return this.frequency(fn.apply(new Time.Builder()).build());
}
/**
* If true, concrete, expanded or aliased indices are ignored when
* frozen.
*
* API name: {@code ignore_throttled}
*
* @deprecated 7.16.0
*/
@Deprecated
public final Builder ignoreThrottled(@Nullable Boolean value) {
this.ignoreThrottled = value;
return this;
}
/**
* If true, unavailable indices (missing or closed) are ignored.
*
* API name: {@code ignore_unavailable}
*/
public final Builder ignoreUnavailable(@Nullable Boolean value) {
this.ignoreUnavailable = value;
return this;
}
/**
* An array of index names. Wildcards are supported. If any of the indices are
* in remote clusters, the machine learning nodes must have the
* remote_cluster_client role.
*
* API name: {@code indices}
*
* Adds all elements of list to indices.
*/
public final Builder indices(List list) {
this.indices = _listAddAll(this.indices, list);
return this;
}
/**
* An array of index names. Wildcards are supported. If any of the indices are
* in remote clusters, the machine learning nodes must have the
* remote_cluster_client role.
*
* API name: {@code indices}
*
* Adds one or more values to indices.
*/
public final Builder indices(String value, String... values) {
this.indices = _listAdd(this.indices, value, values);
return this;
}
/**
* Specifies index expansion options that are used during search.
*
* API name: {@code indices_options}
*/
public final Builder indicesOptions(@Nullable IndicesOptions value) {
this.indicesOptions = value;
return this;
}
/**
* Specifies index expansion options that are used during search.
*
* API name: {@code indices_options}
*/
public final Builder indicesOptions(Function> fn) {
return this.indicesOptions(fn.apply(new IndicesOptions.Builder()).build());
}
/**
* API name: {@code job_id}
*/
public final Builder jobId(@Nullable String value) {
this.jobId = value;
return this;
}
/**
* If a real-time datafeed has never seen any data (including during any initial
* training period), it automatically stops and closes the associated job after
* this many real-time searches return no documents. In other words, it stops
* after frequency times max_empty_searches of
* real-time operation. If not set, a datafeed with no end time that sees no
* data remains started until it is explicitly stopped. By default, it is not
* set.
*
* API name: {@code max_empty_searches}
*/
public final Builder maxEmptySearches(@Nullable Integer value) {
this.maxEmptySearches = value;
return this;
}
/**
* The Elasticsearch query domain-specific language (DSL). This value
* corresponds to the query object in an Elasticsearch search POST body. All the
* options that are supported by Elasticsearch can be used, as this object is
* passed verbatim to Elasticsearch. Note that if you change the query, the
* analyzed data is also changed. Therefore, the time required to learn might be
* long and the understandability of the results is unpredictable. If you want
* to make significant changes to the source data, it is recommended that you
* clone the job and datafeed and make the amendments in the clone. Let both run
* in parallel and close one when you are satisfied with the results of the job.
*
* API name: {@code query}
*/
public final Builder query(@Nullable Query value) {
this.query = value;
return this;
}
/**
* The Elasticsearch query domain-specific language (DSL). This value
* corresponds to the query object in an Elasticsearch search POST body. All the
* options that are supported by Elasticsearch can be used, as this object is
* passed verbatim to Elasticsearch. Note that if you change the query, the
* analyzed data is also changed. Therefore, the time required to learn might be
* long and the understandability of the results is unpredictable. If you want
* to make significant changes to the source data, it is recommended that you
* clone the job and datafeed and make the amendments in the clone. Let both run
* in parallel and close one when you are satisfied with the results of the job.
*
* API name: {@code query}
*/
public final Builder query(Function> fn) {
return this.query(fn.apply(new Query.Builder()).build());
}
/**
* The number of seconds behind real time that data is queried. For example, if
* data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06
* a.m., set this property to 120 seconds. The default value is randomly
* selected between 60s and 120s. This randomness
* improves the query performance when there are multiple jobs running on the
* same node.
*
* API name: {@code query_delay}
*/
public final Builder queryDelay(@Nullable Time value) {
this.queryDelay = value;
return this;
}
/**
* The number of seconds behind real time that data is queried. For example, if
* data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06
* a.m., set this property to 120 seconds. The default value is randomly
* selected between 60s and 120s. This randomness
* improves the query performance when there are multiple jobs running on the
* same node.
*
* API name: {@code query_delay}
*/
public final Builder queryDelay(Function> fn) {
return this.queryDelay(fn.apply(new Time.Builder()).build());
}
/**
* Specifies runtime fields for the datafeed search.
*
* API name: {@code runtime_mappings}
*
* Adds all entries of map to runtimeMappings.
*/
public final Builder runtimeMappings(Map map) {
this.runtimeMappings = _mapPutAll(this.runtimeMappings, map);
return this;
}
/**
* Specifies runtime fields for the datafeed search.
*
* API name: {@code runtime_mappings}
*
* Adds an entry to runtimeMappings.
*/
public final Builder runtimeMappings(String key, RuntimeField value) {
this.runtimeMappings = _mapPut(this.runtimeMappings, key, value);
return this;
}
/**
* Specifies runtime fields for the datafeed search.
*
* API name: {@code runtime_mappings}
*
* Adds an entry to runtimeMappings using a builder lambda.
*/
public final Builder runtimeMappings(String key,
Function> fn) {
return runtimeMappings(key, fn.apply(new RuntimeField.Builder()).build());
}
/**
* Specifies scripts that evaluate custom expressions and returns script fields
* to the datafeed. The detector configuration objects in a job can contain
* functions that use these script fields.
*
* API name: {@code script_fields}
*
* Adds all entries of map to scriptFields.
*/
public final Builder scriptFields(Map map) {
this.scriptFields = _mapPutAll(this.scriptFields, map);
return this;
}
/**
* Specifies scripts that evaluate custom expressions and returns script fields
* to the datafeed. The detector configuration objects in a job can contain
* functions that use these script fields.
*
* API name: {@code script_fields}
*
* Adds an entry to scriptFields.
*/
public final Builder scriptFields(String key, ScriptField value) {
this.scriptFields = _mapPut(this.scriptFields, key, value);
return this;
}
/**
* Specifies scripts that evaluate custom expressions and returns script fields
* to the datafeed. The detector configuration objects in a job can contain
* functions that use these script fields.
*
* API name: {@code script_fields}
*
* Adds an entry to scriptFields using a builder lambda.
*/
public final Builder scriptFields(String key, Function> fn) {
return scriptFields(key, fn.apply(new ScriptField.Builder()).build());
}
/**
* The size parameter that is used in Elasticsearch searches when the datafeed
* does not use aggregations. The maximum value is the value of
* index.max_result_window.
*
* API name: {@code scroll_size}
*/
public final Builder scrollSize(@Nullable Integer value) {
this.scrollSize = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link UpdateDatafeedRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public UpdateDatafeedRequest build() {
_checkSingleUse();
return new UpdateDatafeedRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link UpdateDatafeedRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, UpdateDatafeedRequest::setupUpdateDatafeedRequestDeserializer);
protected static void setupUpdateDatafeedRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::aggregations, JsonpDeserializer.stringMapDeserializer(Aggregation._DESERIALIZER),
"aggregations");
op.add(Builder::chunkingConfig, ChunkingConfig._DESERIALIZER, "chunking_config");
op.add(Builder::delayedDataCheckConfig, DelayedDataCheckConfig._DESERIALIZER, "delayed_data_check_config");
op.add(Builder::frequency, Time._DESERIALIZER, "frequency");
op.add(Builder::indices, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "indices",
"indexes");
op.add(Builder::indicesOptions, IndicesOptions._DESERIALIZER, "indices_options");
op.add(Builder::jobId, JsonpDeserializer.stringDeserializer(), "job_id");
op.add(Builder::maxEmptySearches, JsonpDeserializer.integerDeserializer(), "max_empty_searches");
op.add(Builder::query, Query._DESERIALIZER, "query");
op.add(Builder::queryDelay, Time._DESERIALIZER, "query_delay");
op.add(Builder::runtimeMappings, JsonpDeserializer.stringMapDeserializer(RuntimeField._DESERIALIZER),
"runtime_mappings");
op.add(Builder::scriptFields, JsonpDeserializer.stringMapDeserializer(ScriptField._DESERIALIZER),
"script_fields");
op.add(Builder::scrollSize, JsonpDeserializer.integerDeserializer(), "scroll_size");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ml.update_datafeed}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ml.update_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("/_update");
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 -> {
Map params = new HashMap<>();
if (ApiTypeHelper.isDefined(request.expandWildcards)) {
params.put("expand_wildcards",
request.expandWildcards.stream().map(v -> v.jsonValue()).collect(Collectors.joining(",")));
}
if (request.ignoreUnavailable != null) {
params.put("ignore_unavailable", String.valueOf(request.ignoreUnavailable));
}
if (request.allowNoIndices != null) {
params.put("allow_no_indices", String.valueOf(request.allowNoIndices));
}
if (request.ignoreThrottled != null) {
params.put("ignore_throttled", String.valueOf(request.ignoreThrottled));
}
return params;
}, SimpleEndpoint.emptyMap(), true, UpdateDatafeedResponse._DESERIALIZER);
}