Package org.opensearch.client.opensearch._global

Class UpdateByQueryRequest.Builder

java.lang.Object

org.opensearch.client.opensearch._global.UpdateByQueryRequest.Builder

All Implemented Interfaces:

ObjectBuilder<UpdateByQueryRequest>

Enclosing class:

UpdateByQueryRequest

public static class UpdateByQueryRequest.Builder
extends java.lang.Object
implements ObjectBuilder<UpdateByQueryRequest>

Builder for UpdateByQueryRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UpdateByQueryRequest.Builder	addIndex(java.lang.String value)	Add a value to index(List), creating the list if needed.
UpdateByQueryRequest.Builder	addSort(java.lang.String value)	Add a value to sort(List), creating the list if needed.
UpdateByQueryRequest.Builder	addSourceExcludes(java.lang.String value)	Add a value to sourceExcludes(List), creating the list if needed.
UpdateByQueryRequest.Builder	addSourceIncludes(java.lang.String value)	Add a value to sourceIncludes(List), creating the list if needed.
UpdateByQueryRequest.Builder	addStats(java.lang.String value)	Add a value to stats(List), creating the list if needed.
UpdateByQueryRequest.Builder	addType(java.lang.String value)	Add a value to type(List), creating the list if needed.
UpdateByQueryRequest.Builder	allowNoIndices(java.lang.Boolean value)	API name: allow_no_indices
UpdateByQueryRequest.Builder	analyzer(java.lang.String value)	API name: analyzer
UpdateByQueryRequest.Builder	analyzeWildcard(java.lang.Boolean value)	API name: analyze_wildcard
UpdateByQueryRequest	build()	Builds a UpdateByQueryRequest.
UpdateByQueryRequest.Builder	conflicts(jakarta.json.JsonValue value)	API name: conflicts
UpdateByQueryRequest.Builder	defaultOperator(jakarta.json.JsonValue value)	API name: default_operator
UpdateByQueryRequest.Builder	df(java.lang.String value)	API name: df
UpdateByQueryRequest.Builder	expandWildcards(jakarta.json.JsonValue value)	API name: expand_wildcards
UpdateByQueryRequest.Builder	from(java.lang.Number value)	API name: from
UpdateByQueryRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	API name: ignore_unavailable
UpdateByQueryRequest.Builder	index(java.lang.String... value)	API name: index
UpdateByQueryRequest.Builder	index(java.util.List<java.lang.String> value)	API name: index
UpdateByQueryRequest.Builder	lenient(java.lang.Boolean value)	API name: lenient
UpdateByQueryRequest.Builder	maxDocs(java.lang.Number value)	API name: max_docs
UpdateByQueryRequest.Builder	pipeline(java.lang.String value)	API name: pipeline
UpdateByQueryRequest.Builder	preference(java.lang.String value)	API name: preference
UpdateByQueryRequest.Builder	query(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)	API name: query
UpdateByQueryRequest.Builder	query(QueryContainer value)	API name: query
UpdateByQueryRequest.Builder	queryOnQueryString(java.lang.String value)	API name: query_on_query_string
UpdateByQueryRequest.Builder	refresh(java.lang.Boolean value)	API name: refresh
UpdateByQueryRequest.Builder	requestCache(java.lang.Boolean value)	API name: request_cache
UpdateByQueryRequest.Builder	requestsPerSecond(java.lang.Number value)	API name: requests_per_second
UpdateByQueryRequest.Builder	routing(jakarta.json.JsonValue value)	API name: routing
UpdateByQueryRequest.Builder	script(jakarta.json.JsonValue value)	API name: script
UpdateByQueryRequest.Builder	scroll(jakarta.json.JsonValue value)	API name: scroll
UpdateByQueryRequest.Builder	scrollSize(java.lang.Number value)	API name: scroll_size
UpdateByQueryRequest.Builder	searchTimeout(jakarta.json.JsonValue value)	API name: search_timeout
UpdateByQueryRequest.Builder	searchType(jakarta.json.JsonValue value)	API name: search_type
UpdateByQueryRequest.Builder	size(java.lang.Number value)	API name: size
UpdateByQueryRequest.Builder	slice(java.util.function.Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)	API name: slice
UpdateByQueryRequest.Builder	slice(SlicedScroll value)	API name: slice
UpdateByQueryRequest.Builder	slices(java.lang.Number value)	API name: slices
UpdateByQueryRequest.Builder	sort(java.lang.String... value)	API name: sort
UpdateByQueryRequest.Builder	sort(java.util.List<java.lang.String> value)	API name: sort
UpdateByQueryRequest.Builder	sourceEnabled(java.lang.Boolean value)	API name: source_enabled
UpdateByQueryRequest.Builder	sourceExcludes(java.lang.String... value)	API name: source_excludes
UpdateByQueryRequest.Builder	sourceExcludes(java.util.List<java.lang.String> value)	API name: source_excludes
UpdateByQueryRequest.Builder	sourceIncludes(java.lang.String... value)	API name: source_includes
UpdateByQueryRequest.Builder	sourceIncludes(java.util.List<java.lang.String> value)	API name: source_includes
UpdateByQueryRequest.Builder	stats(java.lang.String... value)	API name: stats
UpdateByQueryRequest.Builder	stats(java.util.List<java.lang.String> value)	API name: stats
UpdateByQueryRequest.Builder	terminateAfter(java.lang.Number value)	API name: terminate_after
UpdateByQueryRequest.Builder	timeout(jakarta.json.JsonValue value)	API name: timeout
UpdateByQueryRequest.Builder	type(java.lang.String... value)	API name: type
UpdateByQueryRequest.Builder	type(java.util.List<java.lang.String> value)	API name: type
UpdateByQueryRequest.Builder	version(java.lang.Boolean value)	API name: version
UpdateByQueryRequest.Builder	versionType(java.lang.Boolean value)	API name: version_type
UpdateByQueryRequest.Builder	waitForActiveShards(jakarta.json.JsonValue value)	API name: wait_for_active_shards
UpdateByQueryRequest.Builder	waitForCompletion(java.lang.Boolean value)	API name: wait_for_completion

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

index

public UpdateByQueryRequest.Builder index(java.util.List<java.lang.String> value)

API name: index

index

public UpdateByQueryRequest.Builder index(java.lang.String... value)

API name: index

addIndex

public UpdateByQueryRequest.Builder addIndex(java.lang.String value)

Add a value to index(List), creating the list if needed.

type

public UpdateByQueryRequest.Builder type(@Nullable java.util.List<java.lang.String> value)

API name: type

type

public UpdateByQueryRequest.Builder type(java.lang.String... value)

API name: type

addType

public UpdateByQueryRequest.Builder addType(java.lang.String value)

Add a value to type(List), creating the list if needed.

allowNoIndices

public UpdateByQueryRequest.Builder allowNoIndices(@Nullable java.lang.Boolean value)

API name: allow_no_indices

analyzer

public UpdateByQueryRequest.Builder analyzer(@Nullable java.lang.String value)

API name: analyzer

analyzeWildcard

public UpdateByQueryRequest.Builder analyzeWildcard(@Nullable java.lang.Boolean value)

API name: analyze_wildcard

defaultOperator

public UpdateByQueryRequest.Builder defaultOperator(@Nullable jakarta.json.JsonValue value)

API name: default_operator

df

public UpdateByQueryRequest.Builder df(@Nullable java.lang.String value)

API name: df

expandWildcards

public UpdateByQueryRequest.Builder expandWildcards(@Nullable jakarta.json.JsonValue value)

API name: expand_wildcards

from

public UpdateByQueryRequest.Builder from(@Nullable java.lang.Number value)

API name: from

ignoreUnavailable

public UpdateByQueryRequest.Builder ignoreUnavailable(@Nullable java.lang.Boolean value)

API name: ignore_unavailable

lenient

public UpdateByQueryRequest.Builder lenient(@Nullable java.lang.Boolean value)

API name: lenient

pipeline

public UpdateByQueryRequest.Builder pipeline(@Nullable java.lang.String value)

API name: pipeline

preference

public UpdateByQueryRequest.Builder preference(@Nullable java.lang.String value)

API name: preference

queryOnQueryString

public UpdateByQueryRequest.Builder queryOnQueryString(@Nullable java.lang.String value)

API name: query_on_query_string

refresh

public UpdateByQueryRequest.Builder refresh(@Nullable java.lang.Boolean value)

API name: refresh

requestCache

public UpdateByQueryRequest.Builder requestCache(@Nullable java.lang.Boolean value)

API name: request_cache

requestsPerSecond

public UpdateByQueryRequest.Builder requestsPerSecond(@Nullable java.lang.Number value)

API name: requests_per_second

routing

public UpdateByQueryRequest.Builder routing(@Nullable jakarta.json.JsonValue value)

API name: routing

scroll

public UpdateByQueryRequest.Builder scroll(@Nullable jakarta.json.JsonValue value)

API name: scroll

scrollSize

public UpdateByQueryRequest.Builder scrollSize(@Nullable java.lang.Number value)

API name: scroll_size

searchTimeout

public UpdateByQueryRequest.Builder searchTimeout(@Nullable jakarta.json.JsonValue value)

API name: search_timeout

searchType

public UpdateByQueryRequest.Builder searchType(@Nullable jakarta.json.JsonValue value)

API name: search_type

size

public UpdateByQueryRequest.Builder size(@Nullable java.lang.Number value)

API name: size

slices

public UpdateByQueryRequest.Builder slices(@Nullable java.lang.Number value)

API name: slices

sort

public UpdateByQueryRequest.Builder sort(@Nullable java.util.List<java.lang.String> value)

API name: sort

sort

public UpdateByQueryRequest.Builder sort(java.lang.String... value)

API name: sort

addSort

public UpdateByQueryRequest.Builder addSort(java.lang.String value)

Add a value to sort(List), creating the list if needed.

sourceEnabled

public UpdateByQueryRequest.Builder sourceEnabled(@Nullable java.lang.Boolean value)

API name: source_enabled

sourceExcludes

public UpdateByQueryRequest.Builder sourceExcludes(@Nullable java.util.List<java.lang.String> value)

API name: source_excludes

sourceExcludes

public UpdateByQueryRequest.Builder sourceExcludes(java.lang.String... value)

API name: source_excludes

addSourceExcludes

public UpdateByQueryRequest.Builder addSourceExcludes(java.lang.String value)

Add a value to sourceExcludes(List), creating the list if needed.

sourceIncludes

public UpdateByQueryRequest.Builder sourceIncludes(@Nullable java.util.List<java.lang.String> value)

API name: source_includes

sourceIncludes

public UpdateByQueryRequest.Builder sourceIncludes(java.lang.String... value)

API name: source_includes

addSourceIncludes

public UpdateByQueryRequest.Builder addSourceIncludes(java.lang.String value)

Add a value to sourceIncludes(List), creating the list if needed.

stats

public UpdateByQueryRequest.Builder stats(@Nullable java.util.List<java.lang.String> value)

API name: stats

stats

public UpdateByQueryRequest.Builder stats(java.lang.String... value)

API name: stats

addStats

public UpdateByQueryRequest.Builder addStats(java.lang.String value)

Add a value to stats(List), creating the list if needed.

terminateAfter

public UpdateByQueryRequest.Builder terminateAfter(@Nullable java.lang.Number value)

API name: terminate_after

timeout

public UpdateByQueryRequest.Builder timeout(@Nullable jakarta.json.JsonValue value)

API name: timeout

version

public UpdateByQueryRequest.Builder version(@Nullable java.lang.Boolean value)

API name: version

versionType

public UpdateByQueryRequest.Builder versionType(@Nullable java.lang.Boolean value)

API name: version_type

waitForActiveShards

public UpdateByQueryRequest.Builder waitForActiveShards(@Nullable jakarta.json.JsonValue value)

API name: wait_for_active_shards

waitForCompletion

public UpdateByQueryRequest.Builder waitForCompletion(@Nullable java.lang.Boolean value)

API name: wait_for_completion

maxDocs

public UpdateByQueryRequest.Builder maxDocs(@Nullable java.lang.Number value)

API name: max_docs

query

public UpdateByQueryRequest.Builder query(@Nullable QueryContainer value)

API name: query

query

public UpdateByQueryRequest.Builder query(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)

API name: query

script

public UpdateByQueryRequest.Builder script(@Nullable jakarta.json.JsonValue value)

API name: script

slice

public UpdateByQueryRequest.Builder slice(@Nullable SlicedScroll value)

API name: slice

slice

public UpdateByQueryRequest.Builder slice(java.util.function.Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)

API name: slice

conflicts

public UpdateByQueryRequest.Builder conflicts(@Nullable jakarta.json.JsonValue value)

API name: conflicts

build

public UpdateByQueryRequest build()

Builds a UpdateByQueryRequest.

Specified by:

build in interface ObjectBuilder<UpdateByQueryRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.