Package org.elasticsearch.action.support.broadcast

Class BroadcastShardRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.support.broadcast.BroadcastShardRequest

All Implemented Interfaces:

IndicesRequest, Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest

Direct Known Subclasses:

FieldUsageShardRequest, ShardUpgradeRequest, ShardValidateQueryRequest

public abstract class BroadcastShardRequest
extends TransportRequest
implements IndicesRequest

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

Modifier and Type	Field	Description
protected OriginalIndices	originalIndices

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BroadcastShardRequest()
	BroadcastShardRequest(StreamInput in)
protected	BroadcastShardRequest(ShardId shardId, OriginalIndices originalIndices)
protected	BroadcastShardRequest(ShardId shardId, BroadcastRequest<? extends BroadcastRequest<?>> request)

Method Summary

Modifier and Type	Method	Description
String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
ShardId	shardId()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

Field Details

originalIndices

protected OriginalIndices originalIndices

Constructor Details

BroadcastShardRequest

protected BroadcastShardRequest()

BroadcastShardRequest

public BroadcastShardRequest(StreamInput in)
                      throws IOException

Throws:

IOException

BroadcastShardRequest

protected BroadcastShardRequest(ShardId shardId,
 BroadcastRequest<? extends BroadcastRequest<?>> request)

BroadcastShardRequest

protected BroadcastShardRequest(ShardId shardId,
 OriginalIndices originalIndices)

Method Details

shardId

public ShardId shardId()

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

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

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 TransportRequest

Throws:

IOException