Class SearchShardsRequest.Builder
java.lang.Object
co.elastic.clients.elasticsearch._core.SearchShardsRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<SearchShardsRequest>
- Enclosing class:
- SearchShardsRequest
public static class SearchShardsRequest.Builder extends java.lang.Object implements ObjectBuilder<SearchShardsRequest>
Builder for
SearchShardsRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description SearchShardsRequest.Builder
addExpandWildcards(ExpandWildcardOptions value)
Add a value toexpandWildcards(List)
, creating the list if needed.SearchShardsRequest.Builder
addIndex(java.lang.String value)
Add a value toindex(List)
, creating the list if needed.SearchShardsRequest.Builder
allowNoIndices(java.lang.Boolean value)
Whether to ignore if a wildcard indices expression resolves into no concrete indices.SearchShardsRequest
build()
Builds aSearchShardsRequest
.SearchShardsRequest.Builder
expandWildcards(ExpandWildcardOptions... value)
Whether to expand wildcard expression to concrete indices that are open, closed or both.SearchShardsRequest.Builder
expandWildcards(java.util.List<ExpandWildcardOptions> value)
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)
A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesSearchShardsRequest.Builder
index(java.util.List<java.lang.String> value)
A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesSearchShardsRequest.Builder
local(java.lang.Boolean value)
Return local information, do not retrieve the state from master 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 valueMethods 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
A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesAPI name:
index
-
index
A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesAPI name:
index
-
addIndex
Add a value toindex(List)
, creating the list if needed. -
allowNoIndices
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 SearchShardsRequest.Builder expandWildcards(@Nullable java.util.List<ExpandWildcardOptions> value)Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
addExpandWildcards
Add a value toexpandWildcards(List)
, creating the list if needed. -
local
Return local information, do not retrieve the state from master node (default: false)API name:
local
-
preference
Specify the node or shard the operation should be performed on (default: random)API name:
preference
-
routing
Specific routing valueAPI name:
routing
-
build
Builds aSearchShardsRequest
.- Specified by:
build
in interfaceObjectBuilder<SearchShardsRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-