org.elasticsearch.action.support.replication

Class IndexReplicationOperationRequest<T extends IndexReplicationOperationRequest>

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.replication.IndexReplicationOperationRequest<T>

All Implemented Interfaces:

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public abstract class IndexReplicationOperationRequest<T extends IndexReplicationOperationRequest>
extends ActionRequest<T>
implements IndicesRequest

Request used within TransportIndexReplicationOperationAction. Since the corresponding action is internal that gets always executed locally, this request never gets sent over the transport. The specified index is expected to be a concrete index. Relies on input validation done by the caller actions.

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.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IndexReplicationOperationRequest(String index, TimeValue timeout, ReplicationType replicationType, WriteConsistencyLevel consistencyLevel, String[] originalIndices, IndicesOptions originalIndicesOptions, ActionRequest request)

Method Summary

Modifier and Type	Method and Description
WriteConsistencyLevel	consistencyLevel()
String	index()
String[]	indices() Returns the array of indices that the action relates to
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
void	readFrom(StreamInput in)
ReplicationType	replicationType()
TimeValue	timeout()
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionRequest

listenerThreaded, listenerThreaded

Methods inherited from class org.elasticsearch.transport.TransportMessage

putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexReplicationOperationRequest

protected IndexReplicationOperationRequest(String index,
                                           TimeValue timeout,
                                           ReplicationType replicationType,
                                           WriteConsistencyLevel consistencyLevel,
                                           String[] originalIndices,
                                           IndicesOptions originalIndicesOptions,
                                           ActionRequest request)

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<T extends IndexReplicationOperationRequest>

timeout

public TimeValue timeout()

index

public String 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

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

replicationType

public ReplicationType replicationType()

consistencyLevel

public WriteConsistencyLevel consistencyLevel()

readFrom

public final void readFrom(StreamInput in)
                    throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<T extends IndexReplicationOperationRequest>

Throws:

IOException

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<T extends IndexReplicationOperationRequest>

Throws:

IOException