Package org.opensearch.client.opensearch.indices

Class ShardStoresRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.ShardStoresRequest.Builder

All Implemented Interfaces:

ObjectBuilder<ShardStoresRequest>

Enclosing class:

ShardStoresRequest

public static class ShardStoresRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<ShardStoresRequest>

Builder for ShardStoresRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShardStoresRequest.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.
ShardStoresRequest	build()	Builds a ShardStoresRequest.
ShardStoresRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Type of index that wildcard patterns can match.
ShardStoresRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Type of index that wildcard patterns can match.
ShardStoresRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	If true, missing or closed indices are not included in the response.
ShardStoresRequest.Builder	index(java.lang.String value, java.lang.String... values)	List of data streams, indices, and aliases used to limit the request.
ShardStoresRequest.Builder	index(java.util.List<java.lang.String> list)	List of data streams, indices, and aliases used to limit the request.
ShardStoresRequest.Builder	status(java.util.List<ShardStoreStatus> list)	List of shard health statuses used to limit the request.
ShardStoresRequest.Builder	status(ShardStoreStatus value, ShardStoreStatus... values)	List of shard health statuses used to limit the request.

Methods inherited from class org.opensearch.client.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 Detail

Builder

public Builder()

Method Detail

allowNoIndices

public final ShardStoresRequest.Builder allowNoIndices(@Nullable
                                                       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. This behavior applies even if the request targets other open indices.

API name: allow_no_indices

expandWildcards

public final ShardStoresRequest.Builder expandWildcards(java.util.List<ExpandWildcard> list)

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.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

public final ShardStoresRequest.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.

API name: expand_wildcards

Adds one or more values to expandWildcards.

ignoreUnavailable

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

If true, missing or closed indices are not included in the response.

API name: ignore_unavailable

index

public final ShardStoresRequest.Builder index(java.util.List<java.lang.String> list)

List of data streams, indices, and aliases used to limit the request.

API name: index

Adds all elements of list to index.

index

public final ShardStoresRequest.Builder index(java.lang.String value,
                                              java.lang.String... values)

List of data streams, indices, and aliases used to limit the request.

API name: index

Adds one or more values to index.

status

public final ShardStoresRequest.Builder status(java.util.List<ShardStoreStatus> list)

List of shard health statuses used to limit the request.

API name: status

Adds all elements of list to status.

status

public final ShardStoresRequest.Builder status(ShardStoreStatus value,
                                               ShardStoreStatus... values)

List of shard health statuses used to limit the request.

API name: status

Adds one or more values to status.

build

public ShardStoresRequest build()

Builds a ShardStoresRequest.

Specified by:

build in interface ObjectBuilder<ShardStoresRequest>

Throws:

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