Class SearchShardsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<SearchShardsRequest.Builder>
co.elastic.clients.elasticsearch.core.SearchShardsRequest.Builder
- All Implemented Interfaces:
WithJson<SearchShardsRequest.Builder>
,ObjectBuilder<SearchShardsRequest>
- Enclosing class:
- SearchShardsRequest
public static class SearchShardsRequest.Builder
extends RequestBase.AbstractBuilder<SearchShardsRequest.Builder>
implements ObjectBuilder<SearchShardsRequest>
Builder for
SearchShardsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoIndices
(Boolean value) Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.build()
Builds aSearchShardsRequest
.expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match.expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard patterns can match.ignoreUnavailable
(Boolean value) Iffalse
, the request returns an error if it targets a missing or closed index.Returns the indices and shards that a search request would be executed against.Returns the indices and shards that a search request would be executed against.Iftrue
, the request retrieves information from the local node only.preference
(String value) Specifies the node or shard the operation should be performed on.Custom value used to route operations to a specific shard.protected SearchShardsRequest.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowNoIndices
Iffalse
, 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
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final SearchShardsRequest.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
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
index
Returns the indices and shards that a search request would be executed against.API name:
index
Adds all elements of
list
toindex
. -
index
Returns the indices and shards that a search request would be executed against.API name:
index
Adds one or more values to
index
. -
local
Iftrue
, the request retrieves information from the local node only.API name:
local
-
preference
Specifies the node or shard the operation should be performed on. Random by default.API name:
preference
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<SearchShardsRequest.Builder>
-
build
Builds aSearchShardsRequest
.- Specified by:
build
in interfaceObjectBuilder<SearchShardsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-