org.elasticsearch.action.support.replication

Class ReplicationRequest<T extends ReplicationRequest<T>>

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Request>

org.elasticsearch.action.support.ChildTaskActionRequest<T>

org.elasticsearch.action.support.replication.ReplicationRequest<T>

All Implemented Interfaces:

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

Direct Known Subclasses:

BulkShardRequest, DeleteRequest, IndexRequest, ShardFlushRequest

public class ReplicationRequest<T extends ReplicationRequest<T>>
extends ChildTaskActionRequest<T>
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

Field Summary

Fields

Modifier and Type	Field and Description
static TimeValue	DEFAULT_TIMEOUT
protected String	index
protected ShardId	shardId Target shard the request should execute on.
protected TimeValue	timeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Modifier	Constructor and Description
	ReplicationRequest()
	ReplicationRequest(ActionRequest request) Creates a new request that inherits headers and context from the request provided as argument.
	ReplicationRequest(ActionRequest request, ShardId shardId) Creates a new request with resolved shard id
protected	ReplicationRequest(T request) Copy constructor that creates a new request that is a copy of the one provided as an argument.
protected	ReplicationRequest(T request, ActionRequest originalRequest) Copy constructor that creates a new request that is a copy of the one provided as an argument.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHaveDuplicates() Is this request can potentially be dup on a single shard.
WriteConsistencyLevel	consistencyLevel()
T	consistencyLevel(WriteConsistencyLevel consistencyLevel) Sets the consistency level of write.
Task	createTask(long id, String type, String action, TaskId parentTaskId)
String	getDescription() Returns optional description of the request to be displayed by the task manager
String	index()
T	index(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)
T	setShardId(ShardId shardId) Sets the target shard id for the request.
ShardId	shardId()
TimeValue	timeout()
T	timeout(String timeout) A timeout to wait if the index operation can't be performed immediately.
T	timeout(TimeValue timeout) A timeout to wait if the index operation can't be performed immediately.
String	toString()
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.ChildTaskActionRequest

createTask, setParentTask

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, wait, wait, wait

Field Detail

DEFAULT_TIMEOUT

public static final TimeValue DEFAULT_TIMEOUT

shardId

protected ShardId shardId

Target shard the request should execute on. In case of index and delete requests, shard id gets resolved by the transport action before performing request operation and at request creation time for shard-level bulk, refresh and flush requests.

timeout

protected TimeValue timeout

index

protected String index

Constructor Detail

ReplicationRequest

public ReplicationRequest()

ReplicationRequest

public ReplicationRequest(ActionRequest request)

Creates a new request that inherits headers and context from the request provided as argument.

ReplicationRequest

public ReplicationRequest(ActionRequest request,
                  ShardId shardId)

Creates a new request with resolved shard id

ReplicationRequest

protected ReplicationRequest(T request)

Copy constructor that creates a new request that is a copy of the one provided as an argument.

ReplicationRequest

protected ReplicationRequest(T request,
                  ActionRequest originalRequest)

Copy constructor that creates a new request that is a copy of the one provided as an argument. The new request will inherit though headers and context from the original request that caused it.

Method Detail

canHaveDuplicates

public boolean canHaveDuplicates()

Is this request can potentially be dup on a single shard.

timeout

public final T timeout(TimeValue timeout)

A timeout to wait if the index operation can't be performed immediately. Defaults to 1m.

timeout

public final T timeout(String timeout)

A timeout to wait if the index operation can't be performed immediately. Defaults to 1m.

timeout

public TimeValue timeout()

index

public String index()

index

public final T index(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

consistencyLevel

public WriteConsistencyLevel consistencyLevel()

shardId

@Nullable
public ShardId shardId()

Returns:

the shardId of the shard where this operation should be executed on. can be null if the shardID has not yet been resolved

consistencyLevel

public final T consistencyLevel(WriteConsistencyLevel consistencyLevel)

Sets the consistency level of write. Defaults to WriteConsistencyLevel.DEFAULT

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<T extends ReplicationRequest<T>>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ChildTaskActionRequest<T extends ReplicationRequest<T>>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ChildTaskActionRequest<T extends ReplicationRequest<T>>

Throws:

IOException

createTask

public Task createTask(long id,
              String type,
              String action,
              TaskId parentTaskId)

Overrides:

createTask in class ChildTaskActionRequest<T extends ReplicationRequest<T>>

setShardId

public T setShardId(ShardId shardId)

Sets the target shard id for the request. The shard id is set when a index/delete request is resolved by the transport action

toString

public String toString()

Overrides:

toString in class Object

getDescription

public String getDescription()

Description copied from class: TransportRequest

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

Overrides:

getDescription in class TransportRequest