Package org.opensearch.client.opensearch.core

Class SearchShardsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.SearchShardsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<SearchShardsRequest>

Enclosing class:

SearchShardsRequest

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

Builder for SearchShardsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SearchShardsRequest.Builder	allowNoIndices(java.lang.Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
SearchShardsRequest	build()	Builds a SearchShardsRequest.
SearchShardsRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
SearchShardsRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
SearchShardsRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
SearchShardsRequest.Builder	index(java.lang.String value, java.lang.String... values)	A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices
SearchShardsRequest.Builder	index(java.util.List<java.lang.String> list)	A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices
SearchShardsRequest.Builder	local(java.lang.Boolean value)	Return local information, do not retrieve the state from cluster-manager node (default: false)
SearchShardsRequest.Builder	preference(java.lang.String value)	Specify the node or shard the operation should be performed on (default: random)
SearchShardsRequest.Builder	routing(java.lang.String value)	Specific routing value

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 SearchShardsRequest.Builder allowNoIndices(@Nullable
                                                        java.lang.Boolean value)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

API name: allow_no_indices

expandWildcards

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

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

public final SearchShardsRequest.Builder expandWildcards(ExpandWildcard value,
                                                         ExpandWildcard... values)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds one or more values to expandWildcards.

ignoreUnavailable

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

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

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

A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

API name: index

Adds all elements of list to index.

index

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

A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

API name: index

Adds one or more values to index.

local

public final SearchShardsRequest.Builder local(@Nullable
                                               java.lang.Boolean value)

Return local information, do not retrieve the state from cluster-manager node (default: false)

API name: local

preference

public final SearchShardsRequest.Builder preference(@Nullable
                                                    java.lang.String value)

Specify the node or shard the operation should be performed on (default: random)

API name: preference

routing

public final SearchShardsRequest.Builder routing(@Nullable
                                                 java.lang.String value)

Specific routing value

API name: routing

build

public SearchShardsRequest build()

Builds a SearchShardsRequest.

Specified by:

build in interface ObjectBuilder<SearchShardsRequest>

Throws:

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