org.elasticsearch.action.support.replication

Class IndicesReplicationOperationRequest<T extends IndicesReplicationOperationRequest>

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

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable

Direct Known Subclasses:

DeleteByQueryRequest

public abstract class IndicesReplicationOperationRequest<T extends IndicesReplicationOperationRequest>
extends ActionRequest<T>
implements IndicesRequest.Replaceable

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
protected WriteConsistencyLevel	consistencyLevel
protected String[]	indices
protected ReplicationType	replicationType
protected TimeValue	timeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IndicesReplicationOperationRequest()
protected	IndicesReplicationOperationRequest(ActionRequest actionRequest)

Method Summary

Modifier and Type	Method and Description
WriteConsistencyLevel	consistencyLevel()
T	consistencyLevel(WriteConsistencyLevel consistencyLevel) Sets the consistency level of write.
String[]	indices() Returns the array of indices that the action relates to
T	indices(String[] indices) The indices the request will execute against.
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
T	indicesOptions(IndicesOptions indicesOptions)
void	readFrom(StreamInput in)
ReplicationType	replicationType()
T	replicationType(ReplicationType replicationType) Sets the replication type.
T	replicationType(String replicationType) Sets the replication type.
TimeValue	timeout()
T	timeout(String timeout) A timeout to wait if the delete by query operation can't be performed immediately.
T	timeout(TimeValue timeout) A timeout to wait if the delete by query 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

timeout

protected TimeValue timeout

indices

protected String[] indices

replicationType

protected ReplicationType replicationType

consistencyLevel

protected WriteConsistencyLevel consistencyLevel

Constructor Detail

IndicesReplicationOperationRequest

protected IndicesReplicationOperationRequest()

IndicesReplicationOperationRequest

protected IndicesReplicationOperationRequest(ActionRequest actionRequest)

Method Detail

timeout

public TimeValue timeout()

timeout

public final T timeout(TimeValue timeout)

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

timeout

public T timeout(String timeout)

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

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

indicesOptions

public T indicesOptions(IndicesOptions indicesOptions)

indices

public final T indices(String[] indices)

The indices the request will execute against.

Specified by:

indices in interface IndicesRequest.Replaceable

replicationType

public ReplicationType replicationType()

replicationType

public final T replicationType(ReplicationType replicationType)

Sets the replication type.

replicationType

public final T replicationType(String replicationType)

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

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<T extends IndicesReplicationOperationRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<T extends IndicesReplicationOperationRequest>

Throws:

IOException