co.elastic.clients.elasticsearch.core.UpdateByQueryRequest 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.core;
import co.elastic.clients.elasticsearch._types.Conflicts;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.ExpandWildcard;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.Script;
import co.elastic.clients.elasticsearch._types.SearchType;
import co.elastic.clients.elasticsearch._types.SlicedScroll;
import co.elastic.clients.elasticsearch._types.Slices;
import co.elastic.clients.elasticsearch._types.Time;
import co.elastic.clients.elasticsearch._types.WaitForActiveShards;
import co.elastic.clients.elasticsearch._types.query_dsl.Operator;
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.Float;
import java.lang.Long;
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: _global.update_by_query.Request
/**
* Update documents. Updates documents that match the specified query. If no
* query is specified, performs an update on every document in the data stream
* or index without modifying the source, which is useful for picking up mapping
* changes.
*
* @see API
* specification
*/
@JsonpDeserializable
public class UpdateByQueryRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final Boolean allowNoIndices;
@Nullable
private final Boolean analyzeWildcard;
@Nullable
private final String analyzer;
@Nullable
private final Conflicts conflicts;
@Nullable
private final Operator defaultOperator;
@Nullable
private final String df;
private final List expandWildcards;
@Nullable
private final Long from;
@Nullable
private final Boolean ignoreUnavailable;
private final List index;
@Nullable
private final Boolean lenient;
@Nullable
private final Long maxDocs;
@Nullable
private final String pipeline;
@Nullable
private final String preference;
@Nullable
private final String q;
@Nullable
private final Query query;
@Nullable
private final Boolean refresh;
@Nullable
private final Boolean requestCache;
@Nullable
private final Float requestsPerSecond;
@Nullable
private final String routing;
@Nullable
private final Script script;
@Nullable
private final Time scroll;
@Nullable
private final Long scrollSize;
@Nullable
private final Time searchTimeout;
@Nullable
private final SearchType searchType;
@Nullable
private final SlicedScroll slice;
@Nullable
private final Slices slices;
private final List sort;
private final List stats;
@Nullable
private final Long terminateAfter;
@Nullable
private final Time timeout;
@Nullable
private final Boolean version;
@Nullable
private final Boolean versionType;
@Nullable
private final WaitForActiveShards waitForActiveShards;
@Nullable
private final Boolean waitForCompletion;
// ---------------------------------------------------------------------------------------------
private UpdateByQueryRequest(Builder builder) {
this.allowNoIndices = builder.allowNoIndices;
this.analyzeWildcard = builder.analyzeWildcard;
this.analyzer = builder.analyzer;
this.conflicts = builder.conflicts;
this.defaultOperator = builder.defaultOperator;
this.df = builder.df;
this.expandWildcards = ApiTypeHelper.unmodifiable(builder.expandWildcards);
this.from = builder.from;
this.ignoreUnavailable = builder.ignoreUnavailable;
this.index = ApiTypeHelper.unmodifiableRequired(builder.index, this, "index");
this.lenient = builder.lenient;
this.maxDocs = builder.maxDocs;
this.pipeline = builder.pipeline;
this.preference = builder.preference;
this.q = builder.q;
this.query = builder.query;
this.refresh = builder.refresh;
this.requestCache = builder.requestCache;
this.requestsPerSecond = builder.requestsPerSecond;
this.routing = builder.routing;
this.script = builder.script;
this.scroll = builder.scroll;
this.scrollSize = builder.scrollSize;
this.searchTimeout = builder.searchTimeout;
this.searchType = builder.searchType;
this.slice = builder.slice;
this.slices = builder.slices;
this.sort = ApiTypeHelper.unmodifiable(builder.sort);
this.stats = ApiTypeHelper.unmodifiable(builder.stats);
this.terminateAfter = builder.terminateAfter;
this.timeout = builder.timeout;
this.version = builder.version;
this.versionType = builder.versionType;
this.waitForActiveShards = builder.waitForActiveShards;
this.waitForCompletion = builder.waitForCompletion;
}
public static UpdateByQueryRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* If false, the request returns an error if any wildcard
* expression, index alias, or _all value targets only missing or
* closed indices. This behavior applies even if the request targets other open
* indices. For example, a request targeting foo*,bar* returns an
* error if an index starts with foo but no index starts with
* bar.
*
* API name: {@code allow_no_indices}
*/
@Nullable
public final Boolean allowNoIndices() {
return this.allowNoIndices;
}
/**
* If true, wildcard and prefix queries are analyzed.
*
* API name: {@code analyze_wildcard}
*/
@Nullable
public final Boolean analyzeWildcard() {
return this.analyzeWildcard;
}
/**
* Analyzer to use for the query string.
*
* API name: {@code analyzer}
*/
@Nullable
public final String analyzer() {
return this.analyzer;
}
/**
* What to do if update by query hits version conflicts: abort or
* proceed.
*
* API name: {@code conflicts}
*/
@Nullable
public final Conflicts conflicts() {
return this.conflicts;
}
/**
* The default operator for query string query: AND or
* OR.
*
* API name: {@code default_operator}
*/
@Nullable
public final Operator defaultOperator() {
return this.defaultOperator;
}
/**
* Field to use as default where no field prefix is given in the query string.
*
* API name: {@code df}
*/
@Nullable
public final String df() {
return this.df;
}
/**
* 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, such as
* open,hidden. Valid values are: all,
* open, closed, hidden,
* none.
*
* API name: {@code expand_wildcards}
*/
public final List expandWildcards() {
return this.expandWildcards;
}
/**
* Starting offset (default: 0)
*
* API name: {@code from}
*/
@Nullable
public final Long from() {
return this.from;
}
/**
* If false, the request returns an error if it targets a missing
* or closed index.
*
* API name: {@code ignore_unavailable}
*/
@Nullable
public final Boolean ignoreUnavailable() {
return this.ignoreUnavailable;
}
/**
* Required - Comma-separated list of data streams, indices, and aliases to
* search. Supports wildcards (*). To search all data streams or
* indices, omit this parameter or use * or _all.
*
* API name: {@code index}
*/
public final List index() {
return this.index;
}
/**
* If true, format-based query failures (such as providing text to
* a numeric field) in the query string will be ignored.
*
* API name: {@code lenient}
*/
@Nullable
public final Boolean lenient() {
return this.lenient;
}
/**
* The maximum number of documents to update.
*
* API name: {@code max_docs}
*/
@Nullable
public final Long maxDocs() {
return this.maxDocs;
}
/**
* ID of the pipeline to use to preprocess incoming documents. If the index has
* a default ingest pipeline specified, then setting the value to
* _none disables the default ingest pipeline for this request. If
* a final pipeline is configured it will always run, regardless of the value of
* this parameter.
*
* API name: {@code pipeline}
*/
@Nullable
public final String pipeline() {
return this.pipeline;
}
/**
* Specifies the node or shard the operation should be performed on. Random by
* default.
*
* API name: {@code preference}
*/
@Nullable
public final String preference() {
return this.preference;
}
/**
* Query in the Lucene query string syntax.
*
* API name: {@code q}
*/
@Nullable
public final String q() {
return this.q;
}
/**
* Specifies the documents to update using the Query DSL.
*
* API name: {@code query}
*/
@Nullable
public final Query query() {
return this.query;
}
/**
* If true, Elasticsearch refreshes affected shards to make the
* operation visible to search.
*
* API name: {@code refresh}
*/
@Nullable
public final Boolean refresh() {
return this.refresh;
}
/**
* If true, the request cache is used for this request.
*
* API name: {@code request_cache}
*/
@Nullable
public final Boolean requestCache() {
return this.requestCache;
}
/**
* The throttle for this request in sub-requests per second.
*
* API name: {@code requests_per_second}
*/
@Nullable
public final Float requestsPerSecond() {
return this.requestsPerSecond;
}
/**
* Custom value used to route operations to a specific shard.
*
* API name: {@code routing}
*/
@Nullable
public final String routing() {
return this.routing;
}
/**
* The script to run to update the document source or metadata when updating.
*
* API name: {@code script}
*/
@Nullable
public final Script script() {
return this.script;
}
/**
* Period to retain the search context for scrolling.
*
* API name: {@code scroll}
*/
@Nullable
public final Time scroll() {
return this.scroll;
}
/**
* Size of the scroll request that powers the operation.
*
* API name: {@code scroll_size}
*/
@Nullable
public final Long scrollSize() {
return this.scrollSize;
}
/**
* Explicit timeout for each search request.
*
* API name: {@code search_timeout}
*/
@Nullable
public final Time searchTimeout() {
return this.searchTimeout;
}
/**
* The type of the search operation. Available options:
* query_then_fetch, dfs_query_then_fetch.
*
* API name: {@code search_type}
*/
@Nullable
public final SearchType searchType() {
return this.searchType;
}
/**
* Slice the request manually using the provided slice ID and total number of
* slices.
*
* API name: {@code slice}
*/
@Nullable
public final SlicedScroll slice() {
return this.slice;
}
/**
* The number of slices this task should be divided into.
*
* API name: {@code slices}
*/
@Nullable
public final Slices slices() {
return this.slices;
}
/**
* A comma-separated list of <field>:<direction> pairs.
*
* API name: {@code sort}
*/
public final List sort() {
return this.sort;
}
/**
* Specific tag of the request for logging and statistical
* purposes.
*
* API name: {@code stats}
*/
public final List stats() {
return this.stats;
}
/**
* Maximum number of documents to collect for each shard. If a query reaches
* this limit, Elasticsearch terminates the query early. Elasticsearch collects
* documents before sorting. Use with caution. Elasticsearch applies this
* parameter to each shard handling the request. When possible, let
* Elasticsearch perform early termination automatically. Avoid specifying this
* parameter for requests that target data streams with backing indices across
* multiple data tiers.
*
* API name: {@code terminate_after}
*/
@Nullable
public final Long terminateAfter() {
return this.terminateAfter;
}
/**
* Period each update request waits for the following operations: dynamic
* mapping updates, waiting for active shards.
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
/**
* If true, returns the document version as part of a hit.
*
* API name: {@code version}
*/
@Nullable
public final Boolean version() {
return this.version;
}
/**
* Should the document increment the version number (internal) on hit or not
* (reindex)
*
* API name: {@code version_type}
*/
@Nullable
public final Boolean versionType() {
return this.versionType;
}
/**
* The number of shard copies that must be active before proceeding with the
* operation. Set to all or any positive integer up to the total
* number of shards in the index (number_of_replicas+1).
*
* API name: {@code wait_for_active_shards}
*/
@Nullable
public final WaitForActiveShards waitForActiveShards() {
return this.waitForActiveShards;
}
/**
* If true, the request blocks until the operation is complete.
*
* API name: {@code wait_for_completion}
*/
@Nullable
public final Boolean waitForCompletion() {
return this.waitForCompletion;
}
/**
* 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.conflicts != null) {
generator.writeKey("conflicts");
this.conflicts.serialize(generator, mapper);
}
if (this.maxDocs != null) {
generator.writeKey("max_docs");
generator.write(this.maxDocs);
}
if (this.query != null) {
generator.writeKey("query");
this.query.serialize(generator, mapper);
}
if (this.script != null) {
generator.writeKey("script");
this.script.serialize(generator, mapper);
}
if (this.slice != null) {
generator.writeKey("slice");
this.slice.serialize(generator, mapper);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link UpdateByQueryRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Boolean allowNoIndices;
@Nullable
private Boolean analyzeWildcard;
@Nullable
private String analyzer;
@Nullable
private Conflicts conflicts;
@Nullable
private Operator defaultOperator;
@Nullable
private String df;
@Nullable
private List expandWildcards;
@Nullable
private Long from;
@Nullable
private Boolean ignoreUnavailable;
private List index;
@Nullable
private Boolean lenient;
@Nullable
private Long maxDocs;
@Nullable
private String pipeline;
@Nullable
private String preference;
@Nullable
private String q;
@Nullable
private Query query;
@Nullable
private Boolean refresh;
@Nullable
private Boolean requestCache;
@Nullable
private Float requestsPerSecond;
@Nullable
private String routing;
@Nullable
private Script script;
@Nullable
private Time scroll;
@Nullable
private Long scrollSize;
@Nullable
private Time searchTimeout;
@Nullable
private SearchType searchType;
@Nullable
private SlicedScroll slice;
@Nullable
private Slices slices;
@Nullable
private List sort;
@Nullable
private List stats;
@Nullable
private Long terminateAfter;
@Nullable
private Time timeout;
@Nullable
private Boolean version;
@Nullable
private Boolean versionType;
@Nullable
private WaitForActiveShards waitForActiveShards;
@Nullable
private Boolean waitForCompletion;
/**
* If false, the request returns an error if any wildcard
* expression, index alias, or _all value targets only missing or
* closed indices. This behavior applies even if the request targets other open
* indices. For example, a request targeting foo*,bar* returns an
* error if an index starts with foo but no index starts with
* bar.
*
* API name: {@code allow_no_indices}
*/
public final Builder allowNoIndices(@Nullable Boolean value) {
this.allowNoIndices = value;
return this;
}
/**
* If true, wildcard and prefix queries are analyzed.
*
* API name: {@code analyze_wildcard}
*/
public final Builder analyzeWildcard(@Nullable Boolean value) {
this.analyzeWildcard = value;
return this;
}
/**
* Analyzer to use for the query string.
*
* API name: {@code analyzer}
*/
public final Builder analyzer(@Nullable String value) {
this.analyzer = value;
return this;
}
/**
* What to do if update by query hits version conflicts: abort or
* proceed.
*
* API name: {@code conflicts}
*/
public final Builder conflicts(@Nullable Conflicts value) {
this.conflicts = value;
return this;
}
/**
* The default operator for query string query: AND or
* OR.
*
* API name: {@code default_operator}
*/
public final Builder defaultOperator(@Nullable Operator value) {
this.defaultOperator = value;
return this;
}
/**
* Field to use as default where no field prefix is given in the query string.
*
* API name: {@code df}
*/
public final Builder df(@Nullable String value) {
this.df = value;
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, such as
* open,hidden. Valid values are: all,
* open, closed, hidden,
* none.
*
* 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, such as
* open,hidden. Valid values are: all,
* open, closed, hidden,
* none.
*
* 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;
}
/**
* Starting offset (default: 0)
*
* API name: {@code from}
*/
public final Builder from(@Nullable Long value) {
this.from = value;
return this;
}
/**
* If false, the request returns an error if it targets a missing
* or closed index.
*
* API name: {@code ignore_unavailable}
*/
public final Builder ignoreUnavailable(@Nullable Boolean value) {
this.ignoreUnavailable = value;
return this;
}
/**
* Required - Comma-separated list of data streams, indices, and aliases to
* search. Supports wildcards (*). To search all data streams or
* indices, omit this parameter or use * or _all.
*
* API name: {@code index}
*
* Adds all elements of list to index.
*/
public final Builder index(List list) {
this.index = _listAddAll(this.index, list);
return this;
}
/**
* Required - Comma-separated list of data streams, indices, and aliases to
* search. Supports wildcards (*). To search all data streams or
* indices, omit this parameter or use * or _all.
*
* API name: {@code index}
*
* Adds one or more values to index.
*/
public final Builder index(String value, String... values) {
this.index = _listAdd(this.index, value, values);
return this;
}
/**
* If true, format-based query failures (such as providing text to
* a numeric field) in the query string will be ignored.
*
* API name: {@code lenient}
*/
public final Builder lenient(@Nullable Boolean value) {
this.lenient = value;
return this;
}
/**
* The maximum number of documents to update.
*
* API name: {@code max_docs}
*/
public final Builder maxDocs(@Nullable Long value) {
this.maxDocs = value;
return this;
}
/**
* ID of the pipeline to use to preprocess incoming documents. If the index has
* a default ingest pipeline specified, then setting the value to
* _none disables the default ingest pipeline for this request. If
* a final pipeline is configured it will always run, regardless of the value of
* this parameter.
*
* API name: {@code pipeline}
*/
public final Builder pipeline(@Nullable String value) {
this.pipeline = value;
return this;
}
/**
* Specifies the node or shard the operation should be performed on. Random by
* default.
*
* API name: {@code preference}
*/
public final Builder preference(@Nullable String value) {
this.preference = value;
return this;
}
/**
* Query in the Lucene query string syntax.
*
* API name: {@code q}
*/
public final Builder q(@Nullable String value) {
this.q = value;
return this;
}
/**
* Specifies the documents to update using the Query DSL.
*
* API name: {@code query}
*/
public final Builder query(@Nullable Query value) {
this.query = value;
return this;
}
/**
* Specifies the documents to update using the Query DSL.
*
* API name: {@code query}
*/
public final Builder query(Function> fn) {
return this.query(fn.apply(new Query.Builder()).build());
}
/**
* If true, Elasticsearch refreshes affected shards to make the
* operation visible to search.
*
* API name: {@code refresh}
*/
public final Builder refresh(@Nullable Boolean value) {
this.refresh = value;
return this;
}
/**
* If true, the request cache is used for this request.
*
* API name: {@code request_cache}
*/
public final Builder requestCache(@Nullable Boolean value) {
this.requestCache = value;
return this;
}
/**
* The throttle for this request in sub-requests per second.
*
* API name: {@code requests_per_second}
*/
public final Builder requestsPerSecond(@Nullable Float value) {
this.requestsPerSecond = value;
return this;
}
/**
* Custom value used to route operations to a specific shard.
*
* API name: {@code routing}
*/
public final Builder routing(@Nullable String value) {
this.routing = value;
return this;
}
/**
* The script to run to update the document source or metadata when updating.
*
* API name: {@code script}
*/
public final Builder script(@Nullable Script value) {
this.script = value;
return this;
}
/**
* The script to run to update the document source or metadata when updating.
*
* API name: {@code script}
*/
public final Builder script(Function> fn) {
return this.script(fn.apply(new Script.Builder()).build());
}
/**
* Period to retain the search context for scrolling.
*
* API name: {@code scroll}
*/
public final Builder scroll(@Nullable Time value) {
this.scroll = value;
return this;
}
/**
* Period to retain the search context for scrolling.
*
* API name: {@code scroll}
*/
public final Builder scroll(Function> fn) {
return this.scroll(fn.apply(new Time.Builder()).build());
}
/**
* Size of the scroll request that powers the operation.
*
* API name: {@code scroll_size}
*/
public final Builder scrollSize(@Nullable Long value) {
this.scrollSize = value;
return this;
}
/**
* Explicit timeout for each search request.
*
* API name: {@code search_timeout}
*/
public final Builder searchTimeout(@Nullable Time value) {
this.searchTimeout = value;
return this;
}
/**
* Explicit timeout for each search request.
*
* API name: {@code search_timeout}
*/
public final Builder searchTimeout(Function> fn) {
return this.searchTimeout(fn.apply(new Time.Builder()).build());
}
/**
* The type of the search operation. Available options:
* query_then_fetch, dfs_query_then_fetch.
*
* API name: {@code search_type}
*/
public final Builder searchType(@Nullable SearchType value) {
this.searchType = value;
return this;
}
/**
* Slice the request manually using the provided slice ID and total number of
* slices.
*
* API name: {@code slice}
*/
public final Builder slice(@Nullable SlicedScroll value) {
this.slice = value;
return this;
}
/**
* Slice the request manually using the provided slice ID and total number of
* slices.
*
* API name: {@code slice}
*/
public final Builder slice(Function> fn) {
return this.slice(fn.apply(new SlicedScroll.Builder()).build());
}
/**
* The number of slices this task should be divided into.
*
* API name: {@code slices}
*/
public final Builder slices(@Nullable Slices value) {
this.slices = value;
return this;
}
/**
* The number of slices this task should be divided into.
*
* API name: {@code slices}
*/
public final Builder slices(Function> fn) {
return this.slices(fn.apply(new Slices.Builder()).build());
}
/**
* A comma-separated list of <field>:<direction> pairs.
*
* API name: {@code sort}
*
* Adds all elements of list to sort.
*/
public final Builder sort(List list) {
this.sort = _listAddAll(this.sort, list);
return this;
}
/**
* A comma-separated list of <field>:<direction> pairs.
*
* API name: {@code sort}
*
* Adds one or more values to sort.
*/
public final Builder sort(String value, String... values) {
this.sort = _listAdd(this.sort, value, values);
return this;
}
/**
* Specific tag of the request for logging and statistical
* purposes.
*
* API name: {@code stats}
*
* Adds all elements of list to stats.
*/
public final Builder stats(List list) {
this.stats = _listAddAll(this.stats, list);
return this;
}
/**
* Specific tag of the request for logging and statistical
* purposes.
*
* API name: {@code stats}
*
* Adds one or more values to stats.
*/
public final Builder stats(String value, String... values) {
this.stats = _listAdd(this.stats, value, values);
return this;
}
/**
* Maximum number of documents to collect for each shard. If a query reaches
* this limit, Elasticsearch terminates the query early. Elasticsearch collects
* documents before sorting. Use with caution. Elasticsearch applies this
* parameter to each shard handling the request. When possible, let
* Elasticsearch perform early termination automatically. Avoid specifying this
* parameter for requests that target data streams with backing indices across
* multiple data tiers.
*
* API name: {@code terminate_after}
*/
public final Builder terminateAfter(@Nullable Long value) {
this.terminateAfter = value;
return this;
}
/**
* Period each update request waits for the following operations: dynamic
* mapping updates, waiting for active shards.
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* Period each update request waits for the following operations: dynamic
* mapping updates, waiting for active shards.
*
* API name: {@code timeout}
*/
public final Builder timeout(Function> fn) {
return this.timeout(fn.apply(new Time.Builder()).build());
}
/**
* If true, returns the document version as part of a hit.
*
* API name: {@code version}
*/
public final Builder version(@Nullable Boolean value) {
this.version = value;
return this;
}
/**
* Should the document increment the version number (internal) on hit or not
* (reindex)
*
* API name: {@code version_type}
*/
public final Builder versionType(@Nullable Boolean value) {
this.versionType = value;
return this;
}
/**
* The number of shard copies that must be active before proceeding with the
* operation. Set to all or any positive integer up to the total
* number of shards in the index (number_of_replicas+1).
*
* API name: {@code wait_for_active_shards}
*/
public final Builder waitForActiveShards(@Nullable WaitForActiveShards value) {
this.waitForActiveShards = value;
return this;
}
/**
* The number of shard copies that must be active before proceeding with the
* operation. Set to all or any positive integer up to the total
* number of shards in the index (number_of_replicas+1).
*
* API name: {@code wait_for_active_shards}
*/
public final Builder waitForActiveShards(
Function> fn) {
return this.waitForActiveShards(fn.apply(new WaitForActiveShards.Builder()).build());
}
/**
* If true, the request blocks until the operation is complete.
*
* API name: {@code wait_for_completion}
*/
public final Builder waitForCompletion(@Nullable Boolean value) {
this.waitForCompletion = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link UpdateByQueryRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public UpdateByQueryRequest build() {
_checkSingleUse();
return new UpdateByQueryRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link UpdateByQueryRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, UpdateByQueryRequest::setupUpdateByQueryRequestDeserializer);
protected static void setupUpdateByQueryRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::conflicts, Conflicts._DESERIALIZER, "conflicts");
op.add(Builder::maxDocs, JsonpDeserializer.longDeserializer(), "max_docs");
op.add(Builder::query, Query._DESERIALIZER, "query");
op.add(Builder::script, Script._DESERIALIZER, "script");
op.add(Builder::slice, SlicedScroll._DESERIALIZER, "slice");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code update_by_query}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/update_by_query",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
final int _index = 1 << 0;
int propsSet = 0;
propsSet |= _index;
if (propsSet == (_index)) {
StringBuilder buf = new StringBuilder();
buf.append("/");
SimpleEndpoint.pathEncode(request.index.stream().map(v -> v).collect(Collectors.joining(",")), buf);
buf.append("/_update_by_query");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _index = 1 << 0;
int propsSet = 0;
propsSet |= _index;
if (propsSet == (_index)) {
params.put("index", request.index.stream().map(v -> v).collect(Collectors.joining(",")));
}
return params;
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.slices != null) {
params.put("slices", request.slices._toJsonString());
}
if (request.df != null) {
params.put("df", request.df);
}
if (request.terminateAfter != null) {
params.put("terminate_after", String.valueOf(request.terminateAfter));
}
if (request.waitForCompletion != null) {
params.put("wait_for_completion", String.valueOf(request.waitForCompletion));
}
if (request.lenient != null) {
params.put("lenient", String.valueOf(request.lenient));
}
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
if (request.routing != null) {
params.put("routing", request.routing);
}
if (request.requestsPerSecond != null) {
params.put("requests_per_second", String.valueOf(request.requestsPerSecond));
}
if (request.ignoreUnavailable != null) {
params.put("ignore_unavailable", String.valueOf(request.ignoreUnavailable));
}
if (ApiTypeHelper.isDefined(request.stats)) {
params.put("stats", request.stats.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (request.allowNoIndices != null) {
params.put("allow_no_indices", String.valueOf(request.allowNoIndices));
}
if (request.analyzer != null) {
params.put("analyzer", request.analyzer);
}
if (request.from != null) {
params.put("from", String.valueOf(request.from));
}
if (ApiTypeHelper.isDefined(request.expandWildcards)) {
params.put("expand_wildcards",
request.expandWildcards.stream().map(v -> v.jsonValue()).collect(Collectors.joining(",")));
}
if (request.versionType != null) {
params.put("version_type", String.valueOf(request.versionType));
}
if (request.preference != null) {
params.put("preference", request.preference);
}
if (request.searchTimeout != null) {
params.put("search_timeout", request.searchTimeout._toJsonString());
}
if (request.analyzeWildcard != null) {
params.put("analyze_wildcard", String.valueOf(request.analyzeWildcard));
}
if (request.scroll != null) {
params.put("scroll", request.scroll._toJsonString());
}
if (request.scrollSize != null) {
params.put("scroll_size", String.valueOf(request.scrollSize));
}
if (request.refresh != null) {
params.put("refresh", String.valueOf(request.refresh));
}
if (ApiTypeHelper.isDefined(request.sort)) {
params.put("sort", request.sort.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (request.searchType != null) {
params.put("search_type", request.searchType.jsonValue());
}
if (request.version != null) {
params.put("version", String.valueOf(request.version));
}
if (request.pipeline != null) {
params.put("pipeline", request.pipeline);
}
if (request.q != null) {
params.put("q", request.q);
}
if (request.defaultOperator != null) {
params.put("default_operator", request.defaultOperator.jsonValue());
}
if (request.waitForActiveShards != null) {
params.put("wait_for_active_shards", request.waitForActiveShards._toJsonString());
}
if (request.requestCache != null) {
params.put("request_cache", String.valueOf(request.requestCache));
}
return params;
}, SimpleEndpoint.emptyMap(), true, UpdateByQueryResponse._DESERIALIZER);
}