org.elasticsearch.action.support.replication

Class ShardReplicationOperationRequest<T extends ShardReplicationOperationRequest>

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.ShardReplicationOperationRequest<T>

All Implemented Interfaces:

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

Direct Known Subclasses:

BulkShardRequest, DeleteRequest, IndexRequest, ShardDeleteByQueryRequest, ShardDeleteRequest

public abstract class ShardReplicationOperationRequest<T extends ShardReplicationOperationRequest>
extends ActionRequest<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 TimeValue	timeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

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

Method Summary

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.
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.
boolean	operationThreaded() Controls if the operation will be executed on a separate thread when executed locally.
T	operationThreaded(boolean threadedOperation) Controls if the operation will be executed on a separate thread when executed locally.
void	readFrom(StreamInput in)
ReplicationType	replicationType() Deprecated. will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
T	replicationType(ReplicationType replicationType) Deprecated. will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
T	replicationType(String replicationType) Deprecated. will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
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.
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

Field Detail

DEFAULT_TIMEOUT

public static final TimeValue DEFAULT_TIMEOUT

timeout

protected TimeValue timeout

index

protected String index

Constructor Detail

ShardReplicationOperationRequest

protected ShardReplicationOperationRequest()

ShardReplicationOperationRequest

protected ShardReplicationOperationRequest(ActionRequest request)

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

ShardReplicationOperationRequest

protected ShardReplicationOperationRequest(T request)

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

ShardReplicationOperationRequest

protected ShardReplicationOperationRequest(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.

operationThreaded

public final boolean operationThreaded()

Controls if the operation will be executed on a separate thread when executed locally.

operationThreaded

public final T operationThreaded(boolean threadedOperation)

Controls if the operation will be executed on a separate thread when executed locally. Defaults to true when running in embedded mode.

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

replicationType

@Deprecated
public ReplicationType replicationType()

Deprecated. will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171

The replication type.

replicationType

@Deprecated
public final T replicationType(ReplicationType replicationType)

Deprecated. will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171

Sets the replication type.

replicationType

@Deprecated
public final T replicationType(String replicationType)

Deprecated. will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171

Sets the replication type.

consistencyLevel

public WriteConsistencyLevel consistencyLevel()

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 ShardReplicationOperationRequest>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<T extends ShardReplicationOperationRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<T extends ShardReplicationOperationRequest>

Throws:

IOException