Module org.elasticsearch.server

Package org.elasticsearch.action.support.master

Class AcknowledgedRequest<Request extends MasterNodeRequest<Request>>

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<Request>

org.elasticsearch.action.support.master.AcknowledgedRequest<Request>

All Implemented Interfaces:

AckedRequest, Writeable, RefCounted, TaskAwareRequest

Direct Known Subclasses:

AcknowledgedRequest.Plain, AddIndexBlockRequest, CleanupRepositoryRequest, CloseIndexRequest, ClusterRerouteRequest, ClusterUpdateSettingsRequest, CreateDataStreamAction.Request, CreateIndexRequest, DeleteDanglingIndexRequest, DeleteIndexRequest, DeletePipelineRequest, DeleteRepositoryRequest, DeleteStoredScriptRequest, ImportDanglingIndexRequest, IndicesAliasesRequest, MigrateToDataStreamAction.Request, ModifyDataStreamsAction.Request, OpenIndexRequest, PutMappingRequest, PutPipelineRequest, PutRepositoryRequest, PutStoredScriptRequest, ResizeRequest, RolloverRequest, TransportDeleteDesiredNodesAction.Request, UpdateDesiredNodesRequest, UpdateSettingsRequest, VerifyRepositoryRequest

public abstract class AcknowledgedRequest<Request extends MasterNodeRequest<Request>>
extends MasterNodeRequest<Request>
implements AckedRequest

Abstract class that allows to mark action requests that support acknowledgements. Facilitates consistency across different api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AcknowledgedRequest.Plain	AcknowledgedRequest that does not have any additional fields.

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

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
static final TimeValue	DEFAULT_ACK_TIMEOUT
protected TimeValue	timeout

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AcknowledgedRequest()
protected	AcknowledgedRequest(StreamInput in)
protected	AcknowledgedRequest(TimeValue timeout)

Method Summary

Modifier and Type	Method	Description
TimeValue	ackTimeout()	Returns the acknowledgement timeout
final TimeValue	timeout()	Returns the current timeout
final Request	timeout(String timeout)	Allows to set the timeout
final Request	timeout(TimeValue timeout)	Allows to set the timeout
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, getRequestId, setParentTask, setRequestId, toString

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.cluster.ack.AckedRequest

masterNodeTimeout

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Details

DEFAULT_ACK_TIMEOUT

public static final TimeValue DEFAULT_ACK_TIMEOUT

timeout

protected TimeValue timeout

Constructor Details

AcknowledgedRequest

protected AcknowledgedRequest()

AcknowledgedRequest

protected AcknowledgedRequest(TimeValue timeout)

AcknowledgedRequest

protected AcknowledgedRequest(StreamInput in)
                       throws IOException

Throws:

IOException

Method Details

timeout

public final Request timeout(String timeout)

Allows to set the timeout

Parameters:

timeout - timeout as a string (e.g. 1s)

Returns:

the request itself

timeout

public final Request timeout(TimeValue timeout)

Allows to set the timeout

Parameters:

timeout - timeout as a TimeValue

Returns:

the request itself

timeout

public final TimeValue timeout()

Returns the current timeout

Returns:

the current timeout as a TimeValue

ackTimeout

public TimeValue ackTimeout()

Description copied from interface: AckedRequest

Returns the acknowledgement timeout

Specified by:

ackTimeout in interface AckedRequest

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 MasterNodeRequest<Request extends MasterNodeRequest<Request>>

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest