Module org.elasticsearch.server

Package org.elasticsearch.action.support.broadcast.unpromotable

Class BroadcastUnpromotableRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.broadcast.unpromotable.BroadcastUnpromotableRequest

All Implemented Interfaces:

IndicesRequest, Writeable, RefCounted, TaskAwareRequest

Direct Known Subclasses:

UnpromotableShardRefreshRequest

public class BroadcastUnpromotableRequest
extends ActionRequest
implements IndicesRequest

A request that is broadcast to the unpromotable assigned replicas of a primary.

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.RemoteClusterShardRequest, 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 final boolean	failShardOnError
protected final String[]	indices
protected final ShardId	shardId

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
BroadcastUnpromotableRequest(IndexShardRoutingTable indexShardRoutingTable)
BroadcastUnpromotableRequest(IndexShardRoutingTable indexShardRoutingTable, boolean failShardOnError)
BroadcastUnpromotableRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	failShardOnError()
String	getDescription()	Returns optional description of the request to be displayed by the task manager
String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
ShardId	shardId()
String	toString()
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, getRequestId, setParentTask, setRequestId

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.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, setParentTask

Field Details

shardId

protected final ShardId shardId

indices

protected final String[] indices

failShardOnError

protected final boolean failShardOnError

Constructor Details

BroadcastUnpromotableRequest

public BroadcastUnpromotableRequest(StreamInput in)
                             throws IOException

Throws:

IOException

BroadcastUnpromotableRequest

public BroadcastUnpromotableRequest(IndexShardRoutingTable indexShardRoutingTable)

BroadcastUnpromotableRequest

public BroadcastUnpromotableRequest(IndexShardRoutingTable indexShardRoutingTable,
 boolean failShardOnError)

Method Details

shardId

public ShardId shardId()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

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 ActionRequest

Throws:

IOException

toString

public String toString()

Overrides:

toString in class TransportRequest

getDescription

public String getDescription()

Description copied from interface: TaskAwareRequest

Returns optional description of the request to be displayed by the task manager

Specified by:

getDescription in interface TaskAwareRequest

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

failShardOnError

public boolean failShardOnError()

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