Class UpdateByQueryRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.UpdateByQueryRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class UpdateByQueryRequest
extends RequestBase
implements JsonpSerializable
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 Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<UpdateByQueryRequest>
Json deserializer forUpdateByQueryRequest
static final Endpoint<UpdateByQueryRequest,
UpdateByQueryResponse, ErrorResponse> Endpoint "update_by_query
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.final String
analyzer()
Analyzer to use for the query string.final Boolean
Iftrue
, wildcard and prefix queries are analyzed.final Conflicts
What to do if update by query hits version conflicts:abort
orproceed
.final Operator
The default operator for query string query:AND
orOR
.final String
df()
Field to use as default where no field prefix is given in the query string.final List<ExpandWildcard>
Type of index that wildcard patterns can match.final Long
from()
Starting offset (default: 0)final Boolean
Iffalse
, the request returns an error if it targets a missing or closed index.index()
Required - Comma-separated list of data streams, indices, and aliases to search.final Boolean
lenient()
Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.final Long
maxDocs()
The maximum number of documents to update.static UpdateByQueryRequest
final String
pipeline()
ID of the pipeline to use to preprocess incoming documents.final String
Specifies the node or shard the operation should be performed on.final Query
query()
Specifies the documents to update using the Query DSL.final Boolean
refresh()
Iftrue
, Elasticsearch refreshes affected shards to make the operation visible to search.final Boolean
Iftrue
, the request cache is used for this request.final Float
The throttle for this request in sub-requests per second.final String
routing()
Custom value used to route operations to a specific shard.final Script
script()
The script to run to update the document source or metadata when updating.final Time
scroll()
Period to retain the search context for scrolling.final Long
Size of the scroll request that powers the operation.final Time
Explicit timeout for each search request.final SearchType
The type of the search operation.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final SlicedScroll
slice()
Slice the request manually using the provided slice ID and total number of slices.final Slices
slices()
The number of slices this task should be divided into.sort()
A comma-separated list of <field>:<direction> pairs.stats()
Specifictag
of the request for logging and statistical purposes.final Long
Maximum number of documents to collect for each shard.final Time
timeout()
Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.final Boolean
version()
Iftrue
, returns the document version as part of a hit.final Boolean
Should the document increment the version number (internal) on hit or not (reindex)final WaitForActiveShards
The number of shard copies that must be active before proceeding with the operation.final Boolean
Iftrue
, the request blocks until the operation is complete.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forUpdateByQueryRequest
-
_ENDPOINT
Endpoint "update_by_query
".
-
-
Method Details
-
of
public static UpdateByQueryRequest of(Function<UpdateByQueryRequest.Builder, ObjectBuilder<UpdateByQueryRequest>> fn) -
allowNoIndices
Iffalse
, 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 targetingfoo*,bar*
returns an error if an index starts withfoo
but no index starts withbar
.API name:
allow_no_indices
-
analyzeWildcard
Iftrue
, wildcard and prefix queries are analyzed.API name:
analyze_wildcard
-
analyzer
Analyzer to use for the query string.API name:
analyzer
-
conflicts
What to do if update by query hits version conflicts:abort
orproceed
.API name:
conflicts
-
defaultOperator
The default operator for query string query:AND
orOR
.API name:
default_operator
-
df
Field to use as default where no field prefix is given in the query string.API name:
df
-
expandWildcards
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 asopen,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
-
from
Starting offset (default: 0)API name:
from
-
index
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:
index
-
lenient
Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.API name:
lenient
-
maxDocs
The maximum number of documents to update.API name:
max_docs
-
pipeline
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:
pipeline
-
preference
Specifies the node or shard the operation should be performed on. Random by default.API name:
preference
-
query
Specifies the documents to update using the Query DSL.API name:
query
-
refresh
Iftrue
, Elasticsearch refreshes affected shards to make the operation visible to search.API name:
refresh
-
requestCache
Iftrue
, the request cache is used for this request.API name:
request_cache
-
requestsPerSecond
The throttle for this request in sub-requests per second.API name:
requests_per_second
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-
script
The script to run to update the document source or metadata when updating.API name:
script
-
scroll
Period to retain the search context for scrolling.API name:
scroll
-
scrollSize
Size of the scroll request that powers the operation.API name:
scroll_size
-
searchTimeout
Explicit timeout for each search request.API name:
search_timeout
-
searchType
The type of the search operation. Available options:query_then_fetch
,dfs_query_then_fetch
.API name:
search_type
-
slice
Slice the request manually using the provided slice ID and total number of slices.API name:
slice
-
slices
The number of slices this task should be divided into.API name:
slices
-
sort
A comma-separated list of <field>:<direction> pairs.API name:
sort
-
stats
Specifictag
of the request for logging and statistical purposes.API name:
stats
-
terminateAfter
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:
terminate_after
-
timeout
Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.API name:
timeout
-
version
Iftrue
, returns the document version as part of a hit.API name:
version
-
versionType
Should the document increment the version number (internal) on hit or not (reindex)API name:
version_type
-
waitForActiveShards
The number of shard copies that must be active before proceeding with the operation. Set toall
or any positive integer up to the total number of shards in the index (number_of_replicas+1
).API name:
wait_for_active_shards
-
waitForCompletion
Iftrue
, the request blocks until the operation is complete.API name:
wait_for_completion
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupUpdateByQueryRequestDeserializer
protected static void setupUpdateByQueryRequestDeserializer(ObjectDeserializer<UpdateByQueryRequest.Builder> op)
-