Class UpdateByQueryRequest.Builder
- All Implemented Interfaces:
WithJson<UpdateByQueryRequest.Builder>
,ObjectBuilder<UpdateByQueryRequest>
- Enclosing class:
- UpdateByQueryRequest
UpdateByQueryRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoIndices
(Boolean value) Whether to ignore if a wildcard indices expression resolves into no concrete indices.The analyzer to use for the query stringanalyzeWildcard
(Boolean value) Specify whether wildcard and prefix queries should be analyzed (default: false)build()
Builds aUpdateByQueryRequest
.API name:conflicts
defaultOperator
(Operator value) The default operator for query string query (AND or OR)The field to use as default where no field prefix is given in the query stringexpandWildcards
(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.expandWildcards
(List<ExpandWildcard> list) Whether to expand wildcard expression to concrete indices that are open, closed or both.Starting offset (default: 0)ignoreUnavailable
(Boolean value) Whether specified concrete indices should be ignored when unavailable (missing or closed)Required - A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesRequired - A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesSpecify whether format-based query failures (such as providing text to a numeric field) should be ignoredAPI name:max_docs
Ingest pipeline to set on index requests made by this action.preference
(String value) Specify the node or shard the operation should be performed on (default: random)API name:query
API name:query
Should the affected indexes be refreshed?requestCache
(Boolean value) Specify if request cache should be used for this request or not, defaults to index level settingrequestsPerSecond
(Long value) The throttle to set on this request in sub-requests per second.A comma-separated list of specific routing valuesAPI name:script
API name:script
Specify how long a consistent view of the index should be maintained for scrolled searchSpecify how long a consistent view of the index should be maintained for scrolled searchscrollSize
(Long value) Size on the scroll request powering the update by querysearchTimeout
(Time value) Explicit timeout for each search request.Explicit timeout for each search request.searchType
(SearchType value) Search operation typeprotected UpdateByQueryRequest.Builder
self()
Deprecated, please usemax_docs
insteadslice
(SlicedScroll value) API name:slice
API name:slice
The number of slices this task should be divided into.The number of slices this task should be divided into.A comma-separated list of <field>:<direction> pairsA comma-separated list of <field>:<direction> pairsSpecific 'tag' of the request for logging and statistical purposesSpecific 'tag' of the request for logging and statistical purposesterminateAfter
(Long value) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.Time each individual bulk request should wait for shards that are unavailable.Time each individual bulk request should wait for shards that are unavailable.A comma-separated list of document types to search; leave empty to perform the operation on all typesA comma-separated list of document types to search; leave empty to perform the operation on all typesSpecify whether to return document version as part of a hitversionType
(Boolean value) Should the document increment the version number (internal) on hit or not (reindex)Sets the number of shard copies that must be active before proceeding with the update by query operation.Sets the number of shard copies that must be active before proceeding with the update by query operation.waitForCompletion
(Boolean value) Should the request should block until the update by query operation is complete.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowNoIndices
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes_all
string or when no indices have been specified)API name:
allow_no_indices
-
analyzeWildcard
Specify whether wildcard and prefix queries should be analyzed (default: false)API name:
analyze_wildcard
-
analyzer
The analyzer to use for the query stringAPI name:
analyzer
-
conflicts
API name:conflicts
-
defaultOperator
The default operator for query string query (AND or OR)API name:
default_operator
-
df
The field to use as default where no field prefix is given in the query stringAPI name:
df
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final UpdateByQueryRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
from
Starting offset (default: 0)API name:
from
-
index
Required - A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesAPI name:
index
Adds all elements of
list
toindex
. -
index
Required - A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesAPI name:
index
Adds one or more values to
index
. -
lenient
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredAPI name:
lenient
-
maxDocs
API name:max_docs
-
pipeline
Ingest pipeline to set on index requests made by this action. (default: none)API name:
pipeline
-
preference
Specify the node or shard the operation should be performed on (default: random)API name:
preference
-
query
API name:query
-
query
API name:query
-
refresh
Should the affected indexes be refreshed?API name:
refresh
-
requestCache
Specify if request cache should be used for this request or not, defaults to index level settingAPI name:
request_cache
-
requestsPerSecond
The throttle to set on this request in sub-requests per second. -1 means no throttle.API name:
requests_per_second
-
routing
A comma-separated list of specific routing valuesAPI name:
routing
-
script
API name:script
-
script
API name:script
-
scroll
Specify how long a consistent view of the index should be maintained for scrolled searchAPI name:
scroll
-
scroll
Specify how long a consistent view of the index should be maintained for scrolled searchAPI name:
scroll
-
scrollSize
Size on the scroll request powering the update by queryAPI name:
scroll_size
-
searchTimeout
Explicit timeout for each search request. Defaults to no timeout.API name:
search_timeout
-
searchTimeout
public final UpdateByQueryRequest.Builder searchTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Explicit timeout for each search request. Defaults to no timeout.API name:
search_timeout
-
searchType
Search operation typeAPI name:
search_type
-
size
Deprecated, please usemax_docs
insteadAPI name:
size
-
slice
API name:slice
-
slice
public final UpdateByQueryRequest.Builder slice(Function<SlicedScroll.Builder, ObjectBuilder<SlicedScroll>> fn) API name:slice
-
slices
The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set toauto
.API name:
slices
-
slices
The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set toauto
.API name:
slices
-
sort
A comma-separated list of <field>:<direction> pairsAPI name:
sort
Adds all elements of
list
tosort
. -
sort
A comma-separated list of <field>:<direction> pairsAPI name:
sort
Adds one or more values to
sort
. -
stats
Specific 'tag' of the request for logging and statistical purposesAPI name:
stats
Adds all elements of
list
tostats
. -
stats
Specific 'tag' of the request for logging and statistical purposesAPI name:
stats
Adds one or more values to
stats
. -
terminateAfter
The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.API name:
terminate_after
-
timeout
Time each individual bulk request should wait for shards that are unavailable.API name:
timeout
-
timeout
Time each individual bulk request should wait for shards that are unavailable.API name:
timeout
-
type
A comma-separated list of document types to search; leave empty to perform the operation on all typesAPI name:
type
Adds all elements of
list
totype
. -
type
A comma-separated list of document types to search; leave empty to perform the operation on all typesAPI name:
type
Adds one or more values to
type
. -
version
Specify whether to return document version as part of a hitAPI name:
version
-
versionType
Should the document increment the version number (internal) on hit or not (reindex)API name:
version_type
-
waitForActiveShards
Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set toall
for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)API name:
wait_for_active_shards
-
waitForActiveShards
public final UpdateByQueryRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set toall
for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)API name:
wait_for_active_shards
-
waitForCompletion
Should the request should block until the update by query operation is complete.API name:
wait_for_completion
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<UpdateByQueryRequest.Builder>
-
build
Builds aUpdateByQueryRequest
.- Specified by:
build
in interfaceObjectBuilder<UpdateByQueryRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-