org.elasticsearch.action.get

Class MultiGetShardRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

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

org.elasticsearch.action.get.MultiGetShardRequest

All Implemented Interfaces:

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

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

Field Summary

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

index, INDICES_OPTIONS

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
MultiGetShardRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	ignoreErrorsOnGeneratedFields()
MultiGetShardRequest	ignoreErrorsOnGeneratedFields(Boolean ignoreErrorsOnGeneratedFields)
String[]	indices() Returns the array of indices that the action relates to
String	preference()
MultiGetShardRequest	preference(String preference) Sets the preference to execute the search.
void	readFrom(StreamInput in)
boolean	realtime()
MultiGetShardRequest	realtime(Boolean realtime)
boolean	refresh()
MultiGetShardRequest	refresh(boolean refresh)
int	shardId()
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

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

index, index, indicesOptions, operationThreaded, operationThreaded, validateNonNullIndex

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiGetShardRequest

public MultiGetShardRequest()

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<MultiGetShardRequest>

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, _primary to execute only on primary 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)

ignoreErrorsOnGeneratedFields

public MultiGetShardRequest ignoreErrorsOnGeneratedFields(Boolean ignoreErrorsOnGeneratedFields)

refresh

public boolean refresh()

refresh

public MultiGetShardRequest refresh(boolean refresh)

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>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class SingleShardRequest<MultiGetShardRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class SingleShardRequest<MultiGetShardRequest>

Throws:

IOException

ignoreErrorsOnGeneratedFields

public boolean ignoreErrorsOnGeneratedFields()