org.elasticsearch.action.admin.cluster.shards

Class ClusterSearchShardsRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response,RequestBuilder>

org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<Request,Response,RequestBuilder>

org.elasticsearch.action.support.master.MasterNodeReadOperationRequestBuilder<ClusterSearchShardsRequest,ClusterSearchShardsResponse,ClusterSearchShardsRequestBuilder>

org.elasticsearch.action.admin.cluster.shards.ClusterSearchShardsRequestBuilder

public class ClusterSearchShardsRequestBuilder
extends MasterNodeReadOperationRequestBuilder<ClusterSearchShardsRequest,ClusterSearchShardsResponse,ClusterSearchShardsRequestBuilder>

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor and Description
ClusterSearchShardsRequestBuilder(ElasticsearchClient client, ClusterSearchShardsAction action)

Method Summary

Methods

Modifier and Type	Method and Description
ClusterSearchShardsRequestBuilder	setIndices(String... indices) Sets the indices the search will be executed on.
ClusterSearchShardsRequestBuilder	setIndicesOptions(IndicesOptions indicesOptions) Specifies what type of requested indices to ignore and how to deal indices wildcard expressions.
ClusterSearchShardsRequestBuilder	setPreference(String preference) Sets the preference to execute the search.
ClusterSearchShardsRequestBuilder	setRouting(String... routing) The routing values to control the shards that the search will be executed on.
ClusterSearchShardsRequestBuilder	setRouting(String routing) A comma separated list of routing values to control the shards the search will be executed on.
ClusterSearchShardsRequestBuilder	setTypes(String... types) The document types to execute the search against.

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeReadOperationRequestBuilder

setLocal

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder

setMasterNodeTimeout, setMasterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

beforeExecute, execute, execute, get, get, get, putHeader, request

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterSearchShardsRequestBuilder

public ClusterSearchShardsRequestBuilder(ElasticsearchClient client,
                                 ClusterSearchShardsAction action)

Method Detail

setIndices

public ClusterSearchShardsRequestBuilder setIndices(String... indices)

Sets the indices the search will be executed on.

setTypes

public ClusterSearchShardsRequestBuilder setTypes(String... types)

The document types to execute the search against. Defaults to be executed against all types.

setRouting

public ClusterSearchShardsRequestBuilder setRouting(String routing)

A comma separated list of routing values to control the shards the search will be executed on.

setRouting

public ClusterSearchShardsRequestBuilder setRouting(String... routing)

The routing values to control the shards that the search will be executed on.

setPreference

public ClusterSearchShardsRequestBuilder setPreference(String preference)

Sets the preference to execute the search. Defaults to randomize across shards. Can be set to _local to prefer local shards, _primary to execute only on primary shards, or a custom value, which guarantees that the same order will be used across different requests.

setIndicesOptions

public ClusterSearchShardsRequestBuilder setIndicesOptions(IndicesOptions indicesOptions)

Specifies what type of requested indices to ignore and how to deal indices wildcard expressions. For example indices that don't exist.