io.searchbox.core

Class SearchShards.Builder

java.lang.Object

io.searchbox.action.AbstractAction.Builder<T,K>

io.searchbox.action.AbstractMultiIndexActionBuilder<T,K>

io.searchbox.action.AbstractMultiTypeActionBuilder<SearchShards,SearchShards.Builder>

io.searchbox.core.SearchShards.Builder

Enclosing class:

SearchShards

public static class SearchShards.Builder
extends AbstractMultiTypeActionBuilder<SearchShards,SearchShards.Builder>

Field Summary

Fields inherited from class io.searchbox.action.AbstractMultiIndexActionBuilder

indexNames

Fields inherited from class io.searchbox.action.AbstractAction.Builder

cleanApiParameters, headers, parameters

Constructor Summary

Constructors

Constructor and Description
SearchShards.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
SearchShards	build()
SearchShards.Builder	local(Boolean local)
SearchShards.Builder	preference(String preference)
SearchShards.Builder	routing(String routing)

Methods inherited from class io.searchbox.action.AbstractMultiTypeActionBuilder

addType, addType, getJoinedTypes

Methods inherited from class io.searchbox.action.AbstractMultiIndexActionBuilder

addIndex, addIndex, allowNoIndices, getJoinedIndices, ignoreUnavailable

Methods inherited from class io.searchbox.action.AbstractAction.Builder

addCleanApiParameter, refresh, resultCasing, setHeader, setHeader, setParameter, setParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchShards.Builder

public SearchShards.Builder()

Method Detail

routing

public SearchShards.Builder routing(String routing)

Parameters:

routing - A comma-separated list of routing values to take into account when determining which shards a request would be executed against.

preference

public SearchShards.Builder preference(String preference)

Parameters:

preference - Controls a preference of which shard replicas to execute the search request on. By default, the operation is randomized between the shard replicas. See the preference documentation for a list of all acceptable values.

local

public SearchShards.Builder local(Boolean local)

Parameters:

local - A boolean value whether to read the cluster state locally in order to determine where shards are allocated instead of using the Master node’s cluster state.

build

public SearchShards build()

Specified by:

build in class AbstractMultiIndexActionBuilder<SearchShards,SearchShards.Builder>