Module org.elasticsearch.server

Package org.elasticsearch.action.get

Class MultiGetShardRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.single.shard.SingleShardRequest<MultiGetShardRequest>

org.elasticsearch.action.get.MultiGetShardRequest

All Implemented Interfaces:

IndicesRequest, Writeable, RefCounted, TaskAwareRequest

public class MultiGetShardRequest
extends SingleShardRequest<MultiGetShardRequest>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.action.support.single.shard.SingleShardRequest

index, INDICES_OPTIONS

Method Summary

Modifier and Type	Method	Description
String[]	indices()	Returns the array of indices that the action relates to
boolean	isForceSyntheticSource()	Should this request force synthetic source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
String	preference()
MultiGetShardRequest	preference(String preference)	Sets the preference to execute the search.
boolean	realtime()
MultiGetShardRequest	realtime(boolean realtime)
boolean	refresh()
MultiGetShardRequest	refresh(boolean refresh)
int	shardId()
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.single.shard.SingleShardRequest

index, index, indicesOptions, validateNonNullIndex

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class SingleShardRequest<MultiGetShardRequest>

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

shardId

public int shardId()

preference

public MultiGetShardRequest preference(String preference)

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

preference

public String preference()

realtime

public boolean realtime()

realtime

public MultiGetShardRequest realtime(boolean realtime)

refresh

public boolean refresh()

refresh

public MultiGetShardRequest refresh(boolean refresh)

isForceSyntheticSource

public boolean isForceSyntheticSource()

Should this request force synthetic source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

Overrides:

indices in class SingleShardRequest<MultiGetShardRequest>