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.BuilderaddIndex(java.lang.String value)Add a value toindex(List), creating the list if needed.UpdateByQueryRequest.BuilderaddSort(java.lang.String value)Add a value tosort(List), creating the list if needed.UpdateByQueryRequest.BuilderaddSourceExcludes(java.lang.String value)Add a value tosourceExcludes(List), creating the list if needed.UpdateByQueryRequest.BuilderaddSourceIncludes(java.lang.String value)Add a value tosourceIncludes(List), creating the list if needed.UpdateByQueryRequest.BuilderaddStats(java.lang.String value)Add a value tostats(List), creating the list if needed.UpdateByQueryRequest.BuilderaddType(java.lang.String value)Add a value totype(List), creating the list if needed.UpdateByQueryRequest.BuilderallowNoIndices(java.lang.Boolean value)API name:allow_no_indicesUpdateByQueryRequest.Builderanalyzer(java.lang.String value)API name:analyzerUpdateByQueryRequest.BuilderanalyzeWildcard(java.lang.Boolean value)API name:analyze_wildcardUpdateByQueryRequestbuild()Builds aUpdateByQueryRequest.UpdateByQueryRequest.Builderconflicts(jakarta.json.JsonValue value)API name:conflictsUpdateByQueryRequest.BuilderdefaultOperator(jakarta.json.JsonValue value)API name:default_operatorUpdateByQueryRequest.Builderdf(java.lang.String value)API name:dfUpdateByQueryRequest.BuilderexpandWildcards(jakarta.json.JsonValue value)API name:expand_wildcardsUpdateByQueryRequest.Builderfrom(java.lang.Number value)API name:fromUpdateByQueryRequest.BuilderignoreUnavailable(java.lang.Boolean value)API name:ignore_unavailableUpdateByQueryRequest.Builderindex(java.lang.String... value)API name:indexUpdateByQueryRequest.Builderindex(java.util.List<java.lang.String> value)API name:indexUpdateByQueryRequest.Builderlenient(java.lang.Boolean value)API name:lenientUpdateByQueryRequest.BuildermaxDocs(java.lang.Number value)API name:max_docsUpdateByQueryRequest.Builderpipeline(java.lang.String value)API name:pipelineUpdateByQueryRequest.Builderpreference(java.lang.String value)API name:preferenceUpdateByQueryRequest.Builderquery(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)API name:queryUpdateByQueryRequest.Builderquery(QueryContainer value)API name:queryUpdateByQueryRequest.BuilderqueryOnQueryString(java.lang.String value)API name:query_on_query_stringUpdateByQueryRequest.Builderrefresh(java.lang.Boolean value)API name:refreshUpdateByQueryRequest.BuilderrequestCache(java.lang.Boolean value)API name:request_cacheUpdateByQueryRequest.BuilderrequestsPerSecond(java.lang.Number value)API name:requests_per_secondUpdateByQueryRequest.Builderrouting(jakarta.json.JsonValue value)API name:routingUpdateByQueryRequest.Builderscript(jakarta.json.JsonValue value)API name:scriptUpdateByQueryRequest.Builderscroll(jakarta.json.JsonValue value)API name:scrollUpdateByQueryRequest.BuilderscrollSize(java.lang.Number value)API name:scroll_sizeUpdateByQueryRequest.BuildersearchTimeout(jakarta.json.JsonValue value)API name:search_timeoutUpdateByQueryRequest.BuildersearchType(jakarta.json.JsonValue value)API name:search_typeUpdateByQueryRequest.Buildersize(java.lang.Number value)API name:sizeUpdateByQueryRequest.Builderslice(java.util.function.Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)API name:sliceUpdateByQueryRequest.Builderslice(SlicedScroll value)API name:sliceUpdateByQueryRequest.Builderslices(java.lang.Number value)API name:slicesUpdateByQueryRequest.Buildersort(java.lang.String... value)API name:sortUpdateByQueryRequest.Buildersort(java.util.List<java.lang.String> value)API name:sortUpdateByQueryRequest.BuildersourceEnabled(java.lang.Boolean value)API name:source_enabledUpdateByQueryRequest.BuildersourceExcludes(java.lang.String... value)API name:source_excludesUpdateByQueryRequest.BuildersourceExcludes(java.util.List<java.lang.String> value)API name:source_excludesUpdateByQueryRequest.BuildersourceIncludes(java.lang.String... value)API name:source_includesUpdateByQueryRequest.BuildersourceIncludes(java.util.List<java.lang.String> value)API name:source_includesUpdateByQueryRequest.Builderstats(java.lang.String... value)API name:statsUpdateByQueryRequest.Builderstats(java.util.List<java.lang.String> value)API name:statsUpdateByQueryRequest.BuilderterminateAfter(java.lang.Number value)API name:terminate_afterUpdateByQueryRequest.Buildertimeout(jakarta.json.JsonValue value)API name:timeoutUpdateByQueryRequest.Buildertype(java.lang.String... value)API name:typeUpdateByQueryRequest.Buildertype(java.util.List<java.lang.String> value)API name:typeUpdateByQueryRequest.Builderversion(java.lang.Boolean value)API name:versionUpdateByQueryRequest.BuilderversionType(java.lang.Boolean value)API name:version_typeUpdateByQueryRequest.BuilderwaitForActiveShards(jakarta.json.JsonValue value)API name:wait_for_active_shardsUpdateByQueryRequest.BuilderwaitForCompletion(java.lang.Boolean value)API name:wait_for_completion
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
index
API name:index -
index
API name:index -
addIndex
Add a value toindex(List), creating the list if needed. -
type
API name:type -
type
API name:type -
addType
Add a value totype(List), creating the list if needed. -
allowNoIndices
API name:allow_no_indices -
analyzer
API name:analyzer -
analyzeWildcard
API name:analyze_wildcard -
defaultOperator
API name:default_operator -
df
API name:df -
expandWildcards
API name:expand_wildcards -
from
API name:from -
ignoreUnavailable
API name:ignore_unavailable -
lenient
API name:lenient -
pipeline
API name:pipeline -
preference
API name:preference -
queryOnQueryString
API name:query_on_query_string -
refresh
API name:refresh -
requestCache
API name:request_cache -
requestsPerSecond
API name:requests_per_second -
routing
API name:routing -
scroll
API name:scroll -
scrollSize
API name:scroll_size -
searchTimeout
API name:search_timeout -
searchType
API name:search_type -
size
API name:size -
slices
API name:slices -
sort
API name:sort -
sort
API name:sort -
addSort
Add a value tosort(List), creating the list if needed. -
sourceEnabled
API name:source_enabled -
sourceExcludes
public UpdateByQueryRequest.Builder sourceExcludes(@Nullable java.util.List<java.lang.String> value)API name:source_excludes -
sourceExcludes
API name:source_excludes -
addSourceExcludes
Add a value tosourceExcludes(List), creating the list if needed. -
sourceIncludes
public UpdateByQueryRequest.Builder sourceIncludes(@Nullable java.util.List<java.lang.String> value)API name:source_includes -
sourceIncludes
API name:source_includes -
addSourceIncludes
Add a value tosourceIncludes(List), creating the list if needed. -
stats
API name:stats -
stats
API name:stats -
addStats
Add a value tostats(List), creating the list if needed. -
terminateAfter
API name:terminate_after -
timeout
API name:timeout -
version
API name:version -
versionType
API name:version_type -
waitForActiveShards
API name:wait_for_active_shards -
waitForCompletion
API name:wait_for_completion -
maxDocs
API name:max_docs -
query
API name:query -
query
public UpdateByQueryRequest.Builder query(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)API name:query -
script
API name:script -
slice
API name:slice -
slice
public UpdateByQueryRequest.Builder slice(java.util.function.Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)API name:slice -
conflicts
API name:conflicts -
build
Builds aUpdateByQueryRequest.- Specified by:
buildin interfaceObjectBuilder<UpdateByQueryRequest>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-