Package co.elastic.clients.elasticsearch.core

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

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allowNoIndices

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

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

API name: ignore_unavailable

index

public final SearchShardsRequest.Builder index(List<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(String value,
 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
 Boolean value)

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

API name: local

preference

public final SearchShardsRequest.Builder preference(@Nullable
 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
 String value)

Specific routing value

API name: routing

self

protected SearchShardsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SearchShardsRequest.Builder>

build

public SearchShardsRequest build()

Builds a SearchShardsRequest.

Specified by:

build in interface ObjectBuilder<SearchShardsRequest>

Throws:

NullPointerException - if some of the required fields are null.