java.lang.Object

org.opensearch.client.opensearch._global.DeleteByQueryRequest.Builder

All Implemented Interfaces:: ObjectBuilder<DeleteByQueryRequest>

Enclosing class:: DeleteByQueryRequest

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

Builder for DeleteByQueryRequest.

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
`DeleteByQueryRequest.Builder`	`addIndex(java.lang.String value)`	Add a value to `index(List)`, creating the list if needed.
`DeleteByQueryRequest.Builder`	`addSort(java.lang.String value)`	Add a value to `sort(List)`, creating the list if needed.
`DeleteByQueryRequest.Builder`	`addSourceExcludes(java.lang.String value)`	Add a value to `sourceExcludes(List)`, creating the list if needed.
`DeleteByQueryRequest.Builder`	`addSourceIncludes(java.lang.String value)`	Add a value to `sourceIncludes(List)`, creating the list if needed.
`DeleteByQueryRequest.Builder`	`addStats(java.lang.String value)`	Add a value to `stats(List)`, creating the list if needed.
`DeleteByQueryRequest.Builder`	`addType(java.lang.String value)`	Add a value to `type(List)`, creating the list if needed.
`DeleteByQueryRequest.Builder`	`allowNoIndices(java.lang.Boolean value)`	API name: `allow_no_indices`
`DeleteByQueryRequest.Builder`	`analyzer(java.lang.String value)`	API name: `analyzer`
`DeleteByQueryRequest.Builder`	`analyzeWildcard(java.lang.Boolean value)`	API name: `analyze_wildcard`
`DeleteByQueryRequest`	`build()`	Builds a `DeleteByQueryRequest`.
`DeleteByQueryRequest.Builder`	`conflicts(jakarta.json.JsonValue value)`	API name: `conflicts`
`DeleteByQueryRequest.Builder`	`defaultOperator(jakarta.json.JsonValue value)`	API name: `default_operator`
`DeleteByQueryRequest.Builder`	`df(java.lang.String value)`	API name: `df`
`DeleteByQueryRequest.Builder`	`expandWildcards(jakarta.json.JsonValue value)`	API name: `expand_wildcards`
`DeleteByQueryRequest.Builder`	`from(java.lang.Number value)`	API name: `from`
`DeleteByQueryRequest.Builder`	`ignoreUnavailable(java.lang.Boolean value)`	API name: `ignore_unavailable`
`DeleteByQueryRequest.Builder`	`index(java.lang.String... value)`	API name: `index`
`DeleteByQueryRequest.Builder`	`index(java.util.List<java.lang.String> value)`	API name: `index`
`DeleteByQueryRequest.Builder`	`lenient(java.lang.Boolean value)`	API name: `lenient`
`DeleteByQueryRequest.Builder`	`maxDocs(java.lang.Number value)`	API name: `max_docs`
`DeleteByQueryRequest.Builder`	`preference(java.lang.String value)`	API name: `preference`
`DeleteByQueryRequest.Builder`	`q(java.lang.String value)`	API name: `q`
`DeleteByQueryRequest.Builder`	`query(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)`	API name: `query`
`DeleteByQueryRequest.Builder`	`query(QueryContainer value)`	API name: `query`
`DeleteByQueryRequest.Builder`	`refresh(java.lang.Boolean value)`	API name: `refresh`
`DeleteByQueryRequest.Builder`	`requestCache(java.lang.Boolean value)`	API name: `request_cache`
`DeleteByQueryRequest.Builder`	`requestsPerSecond(java.lang.Number value)`	API name: `requests_per_second`
`DeleteByQueryRequest.Builder`	`routing(jakarta.json.JsonValue value)`	API name: `routing`
`DeleteByQueryRequest.Builder`	`scroll(jakarta.json.JsonValue value)`	API name: `scroll`
`DeleteByQueryRequest.Builder`	`scrollSize(java.lang.Number value)`	API name: `scroll_size`
`DeleteByQueryRequest.Builder`	`searchTimeout(jakarta.json.JsonValue value)`	API name: `search_timeout`
`DeleteByQueryRequest.Builder`	`searchType(jakarta.json.JsonValue value)`	API name: `search_type`
`DeleteByQueryRequest.Builder`	`size(java.lang.Number value)`	API name: `size`
`DeleteByQueryRequest.Builder`	`slice(java.util.function.Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)`	API name: `slice`
`DeleteByQueryRequest.Builder`	`slice(SlicedScroll value)`	API name: `slice`
`DeleteByQueryRequest.Builder`	`slices(java.lang.Number value)`	API name: `slices`
`DeleteByQueryRequest.Builder`	`sort(java.lang.String... value)`	API name: `sort`
`DeleteByQueryRequest.Builder`	`sort(java.util.List<java.lang.String> value)`	API name: `sort`
`DeleteByQueryRequest.Builder`	`source(jakarta.json.JsonValue value)`	API name: `_source`
`DeleteByQueryRequest.Builder`	`sourceExcludes(java.lang.String... value)`	API name: `_source_excludes`
`DeleteByQueryRequest.Builder`	`sourceExcludes(java.util.List<java.lang.String> value)`	API name: `_source_excludes`
`DeleteByQueryRequest.Builder`	`sourceIncludes(java.lang.String... value)`	API name: `_source_includes`
`DeleteByQueryRequest.Builder`	`sourceIncludes(java.util.List<java.lang.String> value)`	API name: `_source_includes`
`DeleteByQueryRequest.Builder`	`stats(java.lang.String... value)`	API name: `stats`
`DeleteByQueryRequest.Builder`	`stats(java.util.List<java.lang.String> value)`	API name: `stats`
`DeleteByQueryRequest.Builder`	`terminateAfter(java.lang.Number value)`	API name: `terminate_after`
`DeleteByQueryRequest.Builder`	`timeout(jakarta.json.JsonValue value)`	API name: `timeout`
`DeleteByQueryRequest.Builder`	`type(java.lang.String... value)`	API name: `type`
`DeleteByQueryRequest.Builder`	`type(java.util.List<java.lang.String> value)`	API name: `type`
`DeleteByQueryRequest.Builder`	`version(java.lang.Boolean value)`	API name: `version`
`DeleteByQueryRequest.Builder`	`waitForActiveShards(jakarta.json.JsonValue value)`	API name: `wait_for_active_shards`
`DeleteByQueryRequest.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 DeleteByQueryRequest.Builder index(java.util.List<java.lang.String> value)
  
  API name: index
- index
  
  public DeleteByQueryRequest.Builder index(java.lang.String... value)
  
  API name: index
- addIndex
  
  public DeleteByQueryRequest.Builder addIndex(java.lang.String value)
  
  Add a value to index(List), creating the list if needed.
- type
  
  public DeleteByQueryRequest.Builder type(@Nullable java.util.List<java.lang.String> value)
  
  API name: type
- type
  
  public DeleteByQueryRequest.Builder type(java.lang.String... value)
  
  API name: type
- addType
  
  public DeleteByQueryRequest.Builder addType(java.lang.String value)
  
  Add a value to type(List), creating the list if needed.
- allowNoIndices
  
  public DeleteByQueryRequest.Builder allowNoIndices(@Nullable java.lang.Boolean value)
  
  API name: allow_no_indices
- analyzer
  
  public DeleteByQueryRequest.Builder analyzer(@Nullable java.lang.String value)
  
  API name: analyzer
- analyzeWildcard
  
  public DeleteByQueryRequest.Builder analyzeWildcard(@Nullable java.lang.Boolean value)
  
  API name: analyze_wildcard
- conflicts
  
  public DeleteByQueryRequest.Builder conflicts(@Nullable jakarta.json.JsonValue value)
  
  API name: conflicts
- defaultOperator
  
  public DeleteByQueryRequest.Builder defaultOperator(@Nullable jakarta.json.JsonValue value)
  
  API name: default_operator
- df
  
  public DeleteByQueryRequest.Builder df(@Nullable java.lang.String value)
  
  API name: df
- expandWildcards
  
  public DeleteByQueryRequest.Builder expandWildcards(@Nullable jakarta.json.JsonValue value)
  
  API name: expand_wildcards
- from
  
  public DeleteByQueryRequest.Builder from(@Nullable java.lang.Number value)
  
  API name: from
- ignoreUnavailable
  
  public DeleteByQueryRequest.Builder ignoreUnavailable(@Nullable java.lang.Boolean value)
  
  API name: ignore_unavailable
- lenient
  
  public DeleteByQueryRequest.Builder lenient(@Nullable java.lang.Boolean value)
  
  API name: lenient
- preference
  
  public DeleteByQueryRequest.Builder preference(@Nullable java.lang.String value)
  
  API name: preference
- refresh
  
  public DeleteByQueryRequest.Builder refresh(@Nullable java.lang.Boolean value)
  
  API name: refresh
- requestCache
  
  public DeleteByQueryRequest.Builder requestCache(@Nullable java.lang.Boolean value)
  
  API name: request_cache
- requestsPerSecond
  
  public DeleteByQueryRequest.Builder requestsPerSecond(@Nullable java.lang.Number value)
  
  API name: requests_per_second
- routing
  
  public DeleteByQueryRequest.Builder routing(@Nullable jakarta.json.JsonValue value)
  
  API name: routing
- q
  
  public DeleteByQueryRequest.Builder q(@Nullable java.lang.String value)
  
  API name: q
- scroll
  
  public DeleteByQueryRequest.Builder scroll(@Nullable jakarta.json.JsonValue value)
  
  API name: scroll
- scrollSize
  
  public DeleteByQueryRequest.Builder scrollSize(@Nullable java.lang.Number value)
  
  API name: scroll_size
- searchTimeout
  
  public DeleteByQueryRequest.Builder searchTimeout(@Nullable jakarta.json.JsonValue value)
  
  API name: search_timeout
- searchType
  
  public DeleteByQueryRequest.Builder searchType(@Nullable jakarta.json.JsonValue value)
  
  API name: search_type
- size
  
  public DeleteByQueryRequest.Builder size(@Nullable java.lang.Number value)
  
  API name: size
- slices
  
  public DeleteByQueryRequest.Builder slices(@Nullable java.lang.Number value)
  
  API name: slices
- sort
  
  public DeleteByQueryRequest.Builder sort(@Nullable java.util.List<java.lang.String> value)
  
  API name: sort
- sort
  
  public DeleteByQueryRequest.Builder sort(java.lang.String... value)
  
  API name: sort
- addSort
  
  public DeleteByQueryRequest.Builder addSort(java.lang.String value)
  
  Add a value to sort(List), creating the list if needed.
- source
  
  public DeleteByQueryRequest.Builder source(@Nullable jakarta.json.JsonValue value)
  
  API name: _source
- sourceExcludes
  
  public DeleteByQueryRequest.Builder sourceExcludes(@Nullable java.util.List<java.lang.String> value)
  
  API name: _source_excludes
- sourceExcludes
  
  public DeleteByQueryRequest.Builder sourceExcludes(java.lang.String... value)
  
  API name: _source_excludes
- addSourceExcludes
  
  public DeleteByQueryRequest.Builder addSourceExcludes(java.lang.String value)
  
  Add a value to sourceExcludes(List), creating the list if needed.
- sourceIncludes
  
  public DeleteByQueryRequest.Builder sourceIncludes(@Nullable java.util.List<java.lang.String> value)
  
  API name: _source_includes
- sourceIncludes
  
  public DeleteByQueryRequest.Builder sourceIncludes(java.lang.String... value)
  
  API name: _source_includes
- addSourceIncludes
  
  public DeleteByQueryRequest.Builder addSourceIncludes(java.lang.String value)
  
  Add a value to sourceIncludes(List), creating the list if needed.
- stats
  
  public DeleteByQueryRequest.Builder stats(@Nullable java.util.List<java.lang.String> value)
  
  API name: stats
- stats
  
  public DeleteByQueryRequest.Builder stats(java.lang.String... value)
  
  API name: stats
- addStats
  
  public DeleteByQueryRequest.Builder addStats(java.lang.String value)
  
  Add a value to stats(List), creating the list if needed.
- terminateAfter
  
  public DeleteByQueryRequest.Builder terminateAfter(@Nullable java.lang.Number value)
  
  API name: terminate_after
- timeout
  
  public DeleteByQueryRequest.Builder timeout(@Nullable jakarta.json.JsonValue value)
  
  API name: timeout
- version
  
  public DeleteByQueryRequest.Builder version(@Nullable java.lang.Boolean value)
  
  API name: version
- waitForActiveShards
  
  public DeleteByQueryRequest.Builder waitForActiveShards(@Nullable jakarta.json.JsonValue value)
  
  API name: wait_for_active_shards
- waitForCompletion
  
  public DeleteByQueryRequest.Builder waitForCompletion(@Nullable java.lang.Boolean value)
  
  API name: wait_for_completion
- maxDocs
  
  public DeleteByQueryRequest.Builder maxDocs(@Nullable java.lang.Number value)
  
  API name: max_docs
- query
  
  public DeleteByQueryRequest.Builder query(@Nullable QueryContainer value)
  
  API name: query
- query
  
  public DeleteByQueryRequest.Builder query(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)
  
  API name: query
- slice
  
  public DeleteByQueryRequest.Builder slice(@Nullable SlicedScroll value)
  
  API name: slice
- slice
  
  public DeleteByQueryRequest.Builder slice(java.util.function.Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)
  
  API name: slice
- build
  
  public DeleteByQueryRequest build()
  
  Builds a DeleteByQueryRequest.
  
  Specified by:
  
  build in interface ObjectBuilder<DeleteByQueryRequest>
  
  Throws:
  
  java.lang.NullPointerException - if some of the required fields are null.

Class DeleteByQueryRequest.Builder

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details