Package org.opensearch.client.opensearch.indices

Class ShardStoresRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<ShardStoresRequest.Builder>

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

All Implemented Interfaces:

CopyableBuilder<ShardStoresRequest.Builder,ShardStoresRequest>, MutableBuilder<ShardStoresRequest.Builder,ShardStoresRequest>, ObjectBuilder<ShardStoresRequest>

Enclosing class:

ShardStoresRequest

public static class ShardStoresRequest.Builder
extends RequestBase.AbstractBuilder<ShardStoresRequest.Builder>
implements CopyableBuilder<ShardStoresRequest.Builder,ShardStoresRequest>

Builder for ShardStoresRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ShardStoresRequest.Builder	allowNoIndices(Boolean value)	If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.
ShardStoresRequest	build()	Builds a ShardStoresRequest.
ShardStoresRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardStoresRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Type of index that wildcard patterns can match.
final ShardStoresRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Type of index that wildcard patterns can match.
final ShardStoresRequest.Builder	ignoreUnavailable(Boolean value)	If true, missing or closed indexes are not included in the response.
final ShardStoresRequest.Builder	index(String value, String... values)	List of data streams, indexes, and aliases used to limit the request.
final ShardStoresRequest.Builder	index(List<String> list)	List of data streams, indexes, and aliases used to limit the request.
protected ShardStoresRequest.Builder	self()
final ShardStoresRequest.Builder	status(List<ShardStoreStatus> list)	List of shard health statuses used to limit the request.
final ShardStoresRequest.Builder	status(ShardStoreStatus value, ShardStoreStatus... values)	List of shard health statuses used to limit the request.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ShardStoresRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ShardStoresRequest.Builder,ShardStoresRequest>

Returns:

a new builder instance.

self

@Nonnull
protected ShardStoresRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ShardStoresRequest.Builder>

allowNoIndices

@Nonnull
public final ShardStoresRequest.Builder allowNoIndices(@Nullable
 Boolean value)

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.

API name: allow_no_indices

expandWildcards

@Nonnull
public final ShardStoresRequest.Builder expandWildcards(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

@Nonnull
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

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

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

API name: ignore_unavailable

index

@Nonnull
public final ShardStoresRequest.Builder index(List<String> list)

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

API name: index

Adds all elements of list to index.

index

@Nonnull
public final ShardStoresRequest.Builder index(String value,
 String... values)

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

API name: index

Adds one or more values to index.

status

@Nonnull
public final ShardStoresRequest.Builder status(List<ShardStoreStatus> list)

List of shard health statuses used to limit the request.

API name: status

Adds all elements of list to status.

status

@Nonnull
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

@Nonnull
public ShardStoresRequest build()

Builds a ShardStoresRequest.

Specified by:

build in interface ObjectBuilder<ShardStoresRequest>

Throws:

NullPointerException - if some of the required fields are null.