Class IndicesOptions.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<IndicesOptions.Builder>
co.elastic.clients.elasticsearch._types.IndicesOptions.Builder
- All Implemented Interfaces:
WithJson<IndicesOptions.Builder>
,ObjectBuilder<IndicesOptions>
- Enclosing class:
- IndicesOptions
public static class IndicesOptions.Builder extends WithJsonObjectBuilderBase<IndicesOptions.Builder> implements ObjectBuilder<IndicesOptions>
Builder for
IndicesOptions
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description IndicesOptions.Builder
allowNoIndices(java.lang.Boolean value)
If false, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.IndicesOptions
build()
Builds aIndicesOptions
.IndicesOptions.Builder
expandWildcards(ExpandWildcard value, ExpandWildcard... values)
Type of index that wildcard patterns can match.IndicesOptions.Builder
expandWildcards(java.util.List<ExpandWildcard> list)
Type of index that wildcard patterns can match.IndicesOptions.Builder
ignoreThrottled(java.lang.Boolean value)
If true, concrete, expanded or aliased indices are ignored when frozen.IndicesOptions.Builder
ignoreUnavailable(java.lang.Boolean value)
If true, missing or closed indices are not included in the response.protected IndicesOptions.Builder
self()
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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowNoIndices
If false, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targetingfoo*,bar*
returns an error if an index starts withfoo
but no index starts withbar
.API name:
allow_no_indices
-
expandWildcards
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 asopen,hidden
.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final IndicesOptions.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 asopen,hidden
.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
ignoreThrottled
If true, concrete, expanded or aliased indices are ignored when frozen.API name:
ignore_throttled
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<IndicesOptions.Builder>
-
build
Builds aIndicesOptions
.- Specified by:
build
in interfaceObjectBuilder<IndicesOptions>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-