Package org.opensearch.client.opensearch.core

Class UpdateByQueryRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<UpdateByQueryRequest.Builder>

org.opensearch.client.opensearch.core.UpdateByQueryRequest.Builder

All Implemented Interfaces:

CopyableBuilder<UpdateByQueryRequest.Builder,UpdateByQueryRequest>, MutableBuilder<UpdateByQueryRequest.Builder,UpdateByQueryRequest>, ObjectBuilder<UpdateByQueryRequest>

Enclosing class:

UpdateByQueryRequest

public static class UpdateByQueryRequest.Builder
extends RequestBase.AbstractBuilder<UpdateByQueryRequest.Builder>
implements CopyableBuilder<UpdateByQueryRequest.Builder,UpdateByQueryRequest>

Builder for UpdateByQueryRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final UpdateByQueryRequest.Builder	allowNoIndices(Boolean value)	If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.
final UpdateByQueryRequest.Builder	analyzer(String value)	Analyzer to use for the query string.
final UpdateByQueryRequest.Builder	analyzeWildcard(Boolean value)	If true, wildcard and prefix queries are analyzed.
UpdateByQueryRequest	build()	Builds a UpdateByQueryRequest.
final UpdateByQueryRequest.Builder	conflicts(Conflicts value)	API name: conflicts
UpdateByQueryRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final UpdateByQueryRequest.Builder	defaultOperator(Operator value)	The default operator for query string query: AND or OR.
final UpdateByQueryRequest.Builder	df(String value)	Field to use as default where no field prefix is given in the query string.
final UpdateByQueryRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Type of index that wildcard patterns can match.
final UpdateByQueryRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Type of index that wildcard patterns can match.
final UpdateByQueryRequest.Builder	from(Integer value)	Starting offset.
final UpdateByQueryRequest.Builder	ignoreUnavailable(Boolean value)	If false, the request returns an error if it targets a missing or closed index.
final UpdateByQueryRequest.Builder	index(String value, String... values)	Required - Comma-separated list of data streams, indexes, and aliases to search.
final UpdateByQueryRequest.Builder	index(List<String> list)	Required - Comma-separated list of data streams, indexes, and aliases to search.
final UpdateByQueryRequest.Builder	lenient(Boolean value)	If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
final UpdateByQueryRequest.Builder	maxDocs(Integer value)	The maximum number of documents to update.
final UpdateByQueryRequest.Builder	pipeline(String value)	ID of the pipeline to use to preprocess incoming documents.
final UpdateByQueryRequest.Builder	preference(String value)	Specifies the node or shard the operation should be performed on.
final UpdateByQueryRequest.Builder	q(String value)	Query in the Lucene query string syntax.
final UpdateByQueryRequest.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: query
final UpdateByQueryRequest.Builder	query(Query value)	API name: query
final UpdateByQueryRequest.Builder	refresh(Refresh value)	If true, OpenSearch refreshes affected shards to make the operation visible to search.
final UpdateByQueryRequest.Builder	requestCache(Boolean value)	If true, the request cache is used for this request.
final UpdateByQueryRequest.Builder	requestsPerSecond(Float value)	The throttle for this request in sub-requests per second.
final UpdateByQueryRequest.Builder	routing(String value, String... values)	Custom value used to route operations to a specific shard.
final UpdateByQueryRequest.Builder	routing(List<String> list)	Custom value used to route operations to a specific shard.
final UpdateByQueryRequest.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
final UpdateByQueryRequest.Builder	script(Script value)	API name: script
final UpdateByQueryRequest.Builder	scroll(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to retain the search context for scrolling.
final UpdateByQueryRequest.Builder	scroll(Time value)	Period to retain the search context for scrolling.
final UpdateByQueryRequest.Builder	scrollSize(Integer value)	Size of the scroll request that powers the operation.
final UpdateByQueryRequest.Builder	searchTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit timeout for each search request.
final UpdateByQueryRequest.Builder	searchTimeout(Time value)	Explicit timeout for each search request.
final UpdateByQueryRequest.Builder	searchType(SearchType value)	The type of the search operation.
protected UpdateByQueryRequest.Builder	self()
final UpdateByQueryRequest.Builder	size(Integer value)	Deprecated, use max_docs instead.
final UpdateByQueryRequest.Builder	slice(Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)	API name: slice
final UpdateByQueryRequest.Builder	slice(SlicedScroll value)	API name: slice
final UpdateByQueryRequest.Builder	slices(Function<Slices.Builder,ObjectBuilder<Slices>> fn)	The number of slices this task should be divided into.
final UpdateByQueryRequest.Builder	slices(Slices value)	The number of slices this task should be divided into.
final UpdateByQueryRequest.Builder	sort(String value, String... values)	A comma-separated list of <field>:<direction> pairs.
final UpdateByQueryRequest.Builder	sort(List<String> list)	A comma-separated list of <field>:<direction> pairs.
final UpdateByQueryRequest.Builder	source(Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)	Set to true or false to return the _source field or not, or a list of fields to return.
final UpdateByQueryRequest.Builder	source(SourceConfigParam value)	Set to true or false to return the _source field or not, or a list of fields to return.
final UpdateByQueryRequest.Builder	sourceExcludes(String value, String... values)	List of fields to exclude from the returned _source field.
final UpdateByQueryRequest.Builder	sourceExcludes(List<String> list)	List of fields to exclude from the returned _source field.
final UpdateByQueryRequest.Builder	sourceIncludes(String value, String... values)	List of fields to extract and return from the _source field.
final UpdateByQueryRequest.Builder	sourceIncludes(List<String> list)	List of fields to extract and return from the _source field.
final UpdateByQueryRequest.Builder	stats(String value, String... values)	Specific tag of the request for logging and statistical purposes.
final UpdateByQueryRequest.Builder	stats(List<String> list)	Specific tag of the request for logging and statistical purposes.
final UpdateByQueryRequest.Builder	terminateAfter(Integer value)	Maximum number of documents to collect for each shard.
final UpdateByQueryRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.
final UpdateByQueryRequest.Builder	timeout(Time value)	Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.
final UpdateByQueryRequest.Builder	version(Boolean value)	If true, returns the document version as part of a hit.
final UpdateByQueryRequest.Builder	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	The number of shard copies that must be active before proceeding with the operation.
final UpdateByQueryRequest.Builder	waitForActiveShards(WaitForActiveShards value)	The number of shard copies that must be active before proceeding with the operation.
final UpdateByQueryRequest.Builder	waitForCompletion(Boolean value)	If true, the request blocks until the operation is complete.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public UpdateByQueryRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<UpdateByQueryRequest.Builder,UpdateByQueryRequest>

Returns:

a new builder instance.

self

@Nonnull
protected UpdateByQueryRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<UpdateByQueryRequest.Builder>

allowNoIndices

@Nonnull
public final UpdateByQueryRequest.Builder allowNoIndices(@Nullable
 Boolean value)

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

API name: allow_no_indices

analyzeWildcard

@Nonnull
public final UpdateByQueryRequest.Builder analyzeWildcard(@Nullable
 Boolean value)

If true, wildcard and prefix queries are analyzed.

API name: analyze_wildcard

analyzer

@Nonnull
public final UpdateByQueryRequest.Builder analyzer(@Nullable
 String value)

Analyzer to use for the query string.

API name: analyzer

conflicts

@Nonnull
public final UpdateByQueryRequest.Builder conflicts(@Nullable
 Conflicts value)

API name: conflicts

defaultOperator

@Nonnull
public final UpdateByQueryRequest.Builder defaultOperator(@Nullable
 Operator value)

The default operator for query string query: AND or OR.

API name: default_operator

df

@Nonnull
public final UpdateByQueryRequest.Builder df(@Nullable
 String value)

Field to use as default where no field prefix is given in the query string.

API name: df

expandWildcards

@Nonnull
public final UpdateByQueryRequest.Builder expandWildcards(List<ExpandWildcard> list)

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: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

@Nonnull
public final UpdateByQueryRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

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: expand_wildcards

Adds one or more values to expandWildcards.

from

@Nonnull
public final UpdateByQueryRequest.Builder from(@Nullable
 Integer value)

Starting offset.

API name: from

ignoreUnavailable

@Nonnull
public final UpdateByQueryRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

If false, the request returns an error if it targets a missing or closed index.

API name: ignore_unavailable

index

@Nonnull
public final UpdateByQueryRequest.Builder index(List<String> list)

Required - Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). To search all data streams or indexes, omit this parameter or use * or _all.

API name: index

Adds all elements of list to index.

index

@Nonnull
public final UpdateByQueryRequest.Builder index(String value,
 String... values)

Required - Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). To search all data streams or indexes, omit this parameter or use * or _all.

API name: index

Adds one or more values to index.

lenient

@Nonnull
public final UpdateByQueryRequest.Builder lenient(@Nullable
 Boolean value)

If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.

API name: lenient

maxDocs

@Nonnull
public final UpdateByQueryRequest.Builder maxDocs(@Nullable
 Integer value)

The maximum number of documents to update.

API name: max_docs

pipeline

@Nonnull
public final UpdateByQueryRequest.Builder pipeline(@Nullable
 String value)

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

@Nonnull
public final UpdateByQueryRequest.Builder preference(@Nullable
 String value)

Specifies the node or shard the operation should be performed on. Random by default.

API name: preference

q

@Nonnull
public final UpdateByQueryRequest.Builder q(@Nullable
 String value)

Query in the Lucene query string syntax.

API name: q

query

@Nonnull
public final UpdateByQueryRequest.Builder query(@Nullable
 Query value)

API name: query

query

@Nonnull
public final UpdateByQueryRequest.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: query

refresh

@Nonnull
public final UpdateByQueryRequest.Builder refresh(@Nullable
 Refresh value)

If true, OpenSearch refreshes affected shards to make the operation visible to search.

API name: refresh

requestCache

@Nonnull
public final UpdateByQueryRequest.Builder requestCache(@Nullable
 Boolean value)

If true, the request cache is used for this request.

API name: request_cache

requestsPerSecond

@Nonnull
public final UpdateByQueryRequest.Builder requestsPerSecond(@Nullable
 Float value)

The throttle for this request in sub-requests per second.

API name: requests_per_second

routing

@Nonnull
public final UpdateByQueryRequest.Builder routing(List<String> list)

Custom value used to route operations to a specific shard.

API name: routing

Adds all elements of list to routing.

routing

@Nonnull
public final UpdateByQueryRequest.Builder routing(String value,
 String... values)

Custom value used to route operations to a specific shard.

API name: routing

Adds one or more values to routing.

script

@Nonnull
public final UpdateByQueryRequest.Builder script(@Nullable
 Script value)

API name: script

script

@Nonnull
public final UpdateByQueryRequest.Builder script(Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: script

scroll

@Nonnull
public final UpdateByQueryRequest.Builder scroll(@Nullable
 Time value)

Period to retain the search context for scrolling.

API name: scroll

scroll

@Nonnull
public final UpdateByQueryRequest.Builder scroll(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to retain the search context for scrolling.

API name: scroll

scrollSize

@Nonnull
public final UpdateByQueryRequest.Builder scrollSize(@Nullable
 Integer value)

Size of the scroll request that powers the operation.

API name: scroll_size

searchTimeout

@Nonnull
public final UpdateByQueryRequest.Builder searchTimeout(@Nullable
 Time value)

Explicit timeout for each search request.

API name: search_timeout

searchTimeout

@Nonnull
public final UpdateByQueryRequest.Builder searchTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit timeout for each search request.

API name: search_timeout

searchType

@Nonnull
public final UpdateByQueryRequest.Builder searchType(@Nullable
 SearchType value)

The type of the search operation. Available options: query_then_fetch, dfs_query_then_fetch.

API name: search_type

size

@Nonnull
public final UpdateByQueryRequest.Builder size(@Nullable
 Integer value)

Deprecated, use max_docs instead.

API name: size

slice

@Nonnull
public final UpdateByQueryRequest.Builder slice(@Nullable
 SlicedScroll value)

API name: slice

slice

@Nonnull
public final UpdateByQueryRequest.Builder slice(Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)

API name: slice

slices

@Nonnull
public final UpdateByQueryRequest.Builder slices(@Nullable
 Slices value)

The number of slices this task should be divided into.

API name: slices

slices

@Nonnull
public final UpdateByQueryRequest.Builder slices(Function<Slices.Builder,ObjectBuilder<Slices>> fn)

The number of slices this task should be divided into.

API name: slices

sort

@Nonnull
public final UpdateByQueryRequest.Builder sort(List<String> list)

A comma-separated list of <field>:<direction> pairs.

API name: sort

Adds all elements of list to sort.

sort

@Nonnull
public final UpdateByQueryRequest.Builder sort(String value,
 String... values)

A comma-separated list of <field>:<direction> pairs.

API name: sort

Adds one or more values to sort.

source

@Nonnull
public final UpdateByQueryRequest.Builder source(@Nullable
 SourceConfigParam value)

Set to true or false to return the _source field or not, or a list of fields to return.

API name: _source

source

@Nonnull
public final UpdateByQueryRequest.Builder source(Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)

Set to true or false to return the _source field or not, or a list of fields to return.

API name: _source

sourceExcludes

@Nonnull
public final UpdateByQueryRequest.Builder sourceExcludes(List<String> list)

List of fields to exclude from the returned _source field.

API name: _source_excludes

Adds all elements of list to sourceExcludes.

sourceExcludes

@Nonnull
public final UpdateByQueryRequest.Builder sourceExcludes(String value,
 String... values)

List of fields to exclude from the returned _source field.

API name: _source_excludes

Adds one or more values to sourceExcludes.

sourceIncludes

@Nonnull
public final UpdateByQueryRequest.Builder sourceIncludes(List<String> list)

List of fields to extract and return from the _source field.

API name: _source_includes

Adds all elements of list to sourceIncludes.

sourceIncludes

@Nonnull
public final UpdateByQueryRequest.Builder sourceIncludes(String value,
 String... values)

List of fields to extract and return from the _source field.

API name: _source_includes

Adds one or more values to sourceIncludes.

stats

@Nonnull
public final UpdateByQueryRequest.Builder stats(List<String> list)

Specific tag of the request for logging and statistical purposes.

API name: stats

Adds all elements of list to stats.

stats

@Nonnull
public final UpdateByQueryRequest.Builder stats(String value,
 String... values)

Specific tag of the request for logging and statistical purposes.

API name: stats

Adds one or more values to stats.

terminateAfter

@Nonnull
public final UpdateByQueryRequest.Builder terminateAfter(@Nullable
 Integer value)

Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers.

API name: terminate_after

timeout

@Nonnull
public final UpdateByQueryRequest.Builder timeout(@Nullable
 Time value)

Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.

API name: timeout

timeout

@Nonnull
public final UpdateByQueryRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.

API name: timeout

version

@Nonnull
public final UpdateByQueryRequest.Builder version(@Nullable
 Boolean value)

If true, returns the document version as part of a hit.

API name: version

waitForActiveShards

@Nonnull
public final UpdateByQueryRequest.Builder waitForActiveShards(@Nullable
 WaitForActiveShards value)

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: wait_for_active_shards

waitForActiveShards

@Nonnull
public final UpdateByQueryRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)

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: wait_for_active_shards

waitForCompletion

@Nonnull
public final UpdateByQueryRequest.Builder waitForCompletion(@Nullable
 Boolean value)

If true, the request blocks until the operation is complete.

API name: wait_for_completion

build

@Nonnull
public UpdateByQueryRequest build()

Builds a UpdateByQueryRequest.

Specified by:

build in interface ObjectBuilder<UpdateByQueryRequest>

Throws:

NullPointerException - if some of the required fields are null.