Package co.elastic.clients.elasticsearch.core

Class UpdateByQueryRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<UpdateByQueryRequest.Builder>

co.elastic.clients.elasticsearch.core.UpdateByQueryRequest.Builder

All Implemented Interfaces:

WithJson<UpdateByQueryRequest.Builder>, ObjectBuilder<UpdateByQueryRequest>

Enclosing class:

UpdateByQueryRequest

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

Builder for UpdateByQueryRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final UpdateByQueryRequest.Builder	allowNoIndices(Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
final UpdateByQueryRequest.Builder	analyzer(String value)	The analyzer to use for the query string
final UpdateByQueryRequest.Builder	analyzeWildcard(Boolean value)	Specify whether wildcard and prefix queries should be analyzed (default: false)
UpdateByQueryRequest	build()	Builds a UpdateByQueryRequest.
final UpdateByQueryRequest.Builder	conflicts(Conflicts value)	API name: conflicts
final UpdateByQueryRequest.Builder	defaultOperator(Operator value)	The default operator for query string query (AND or OR)
final UpdateByQueryRequest.Builder	df(String value)	The field to use as default where no field prefix is given in the query string
final UpdateByQueryRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final UpdateByQueryRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final UpdateByQueryRequest.Builder	from(Long value)	Starting offset (default: 0)
final UpdateByQueryRequest.Builder	ignoreUnavailable(Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
final UpdateByQueryRequest.Builder	index(String value, String... values)	Required - A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices
final UpdateByQueryRequest.Builder	index(List<String> list)	Required - A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices
final UpdateByQueryRequest.Builder	lenient(Boolean value)	Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
final UpdateByQueryRequest.Builder	maxDocs(Long value)	API name: max_docs
final UpdateByQueryRequest.Builder	pipeline(String value)	Ingest pipeline to set on index requests made by this action.
final UpdateByQueryRequest.Builder	preference(String value)	Specify the node or shard the operation should be performed on (default: random)
final UpdateByQueryRequest.Builder	query(Query value)	API name: query
final UpdateByQueryRequest.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: query
final UpdateByQueryRequest.Builder	refresh(Boolean value)	Should the affected indexes be refreshed?
final UpdateByQueryRequest.Builder	requestCache(Boolean value)	Specify if request cache should be used for this request or not, defaults to index level setting
final UpdateByQueryRequest.Builder	requestsPerSecond(Float value)	The throttle to set on this request in sub-requests per second.
final UpdateByQueryRequest.Builder	routing(String value)	A comma-separated list of specific routing values
final UpdateByQueryRequest.Builder	script(Script value)	API name: script
final UpdateByQueryRequest.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
final UpdateByQueryRequest.Builder	scroll(Time value)	Specify how long a consistent view of the index should be maintained for scrolled search
final UpdateByQueryRequest.Builder	scroll(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify how long a consistent view of the index should be maintained for scrolled search
final UpdateByQueryRequest.Builder	scrollSize(Long value)	Size on the scroll request powering the update by query
final UpdateByQueryRequest.Builder	searchTimeout(Time value)	Explicit timeout for each search request.
final UpdateByQueryRequest.Builder	searchTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit timeout for each search request.
final UpdateByQueryRequest.Builder	searchType(SearchType value)	Search operation type
protected UpdateByQueryRequest.Builder	self()
final UpdateByQueryRequest.Builder	slice(SlicedScroll value)	API name: slice
final UpdateByQueryRequest.Builder	slice(Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)	API name: slice
final UpdateByQueryRequest.Builder	slices(Slices value)	The number of slices this task should be divided into.
final UpdateByQueryRequest.Builder	slices(Function<Slices.Builder,ObjectBuilder<Slices>> fn)	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	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(Long value)	The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
final UpdateByQueryRequest.Builder	timeout(Time value)	Time each individual bulk request should wait for shards that are unavailable.
final UpdateByQueryRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Time each individual bulk request should wait for shards that are unavailable.
final UpdateByQueryRequest.Builder	version(Boolean value)	Specify whether to return document version as part of a hit
final UpdateByQueryRequest.Builder	versionType(Boolean value)	Should the document increment the version number (internal) on hit or not (reindex)
final UpdateByQueryRequest.Builder	waitForActiveShards(WaitForActiveShards value)	Sets the number of shard copies that must be active before proceeding with the update by query operation.
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.
final UpdateByQueryRequest.Builder	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

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allowNoIndices

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

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

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

Specify whether wildcard and prefix queries should be analyzed (default: false)

API name: analyze_wildcard

analyzer

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

The analyzer to use for the query string

API name: analyzer

conflicts

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

API name: conflicts

defaultOperator

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

The default operator for query string query (AND or OR)

API name: default_operator

df

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

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

API name: df

expandWildcards

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

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

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

public final UpdateByQueryRequest.Builder from(@Nullable
 Long value)

Starting offset (default: 0)

API name: from

ignoreUnavailable

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

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

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

Required - A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

API name: index

Adds all elements of list to index.

index

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

Required - A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

API name: index

Adds one or more values to index.

lenient

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

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

API name: lenient

maxDocs

public final UpdateByQueryRequest.Builder maxDocs(@Nullable
 Long value)

API name: max_docs

pipeline

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

Ingest pipeline to set on index requests made by this action. (default: none)

API name: pipeline

preference

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

Specify the node or shard the operation should be performed on (default: random)

API name: preference

query

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

API name: query

query

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

API name: query

refresh

public final UpdateByQueryRequest.Builder refresh(@Nullable
 Boolean value)

Should the affected indexes be refreshed?

API name: refresh

requestCache

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

Specify if request cache should be used for this request or not, defaults to index level setting

API name: request_cache

requestsPerSecond

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

The throttle to set on this request in sub-requests per second. -1 means no throttle.

API name: requests_per_second

routing

public final UpdateByQueryRequest.Builder routing(@Nullable
 String value)

A comma-separated list of specific routing values

API name: routing

script

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

API name: script

script

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

API name: script

scroll

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

Specify how long a consistent view of the index should be maintained for scrolled search

API name: scroll

scroll

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

Specify how long a consistent view of the index should be maintained for scrolled search

API name: scroll

scrollSize

public final UpdateByQueryRequest.Builder scrollSize(@Nullable
 Long value)

Size on the scroll request powering the update by query

API name: scroll_size

searchTimeout

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

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

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

Search operation type

API name: search_type

slice

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

API name: slice

slice

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

API name: slice

slices

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

The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to auto.

API name: slices

slices

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

The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to auto.

API name: slices

sort

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

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.

stats

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

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

public final UpdateByQueryRequest.Builder terminateAfter(@Nullable
 Long value)

The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.

API name: terminate_after

timeout

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

Time each individual bulk request should wait for shards that are unavailable.

API name: timeout

timeout

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

Time each individual bulk request should wait for shards that are unavailable.

API name: timeout

version

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

Specify whether to return document version as part of a hit

API name: version

versionType

public final UpdateByQueryRequest.Builder versionType(@Nullable
 Boolean value)

Should the document increment the version number (internal) on hit or not (reindex)

API name: version_type

waitForActiveShards

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

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 to all 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 to all 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

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

Should the request should block until the update by query operation is complete.

API name: wait_for_completion

self

protected UpdateByQueryRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<UpdateByQueryRequest.Builder>

build

public UpdateByQueryRequest build()

Builds a UpdateByQueryRequest.

Specified by:

build in interface ObjectBuilder<UpdateByQueryRequest>

Throws:

NullPointerException - if some of the required fields are null.