Package org.opensearch.indices.replication.checkpoint

Class PublishCheckpointRequest

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.action.support.replication.ReplicationRequest<PublishCheckpointRequest>

org.opensearch.indices.replication.checkpoint.PublishCheckpointRequest

All Implemented Interfaces:

IndicesRequest, Writeable, TaskAwareRequest

public class PublishCheckpointRequest
extends ReplicationRequest<PublishCheckpointRequest>

Replication request responsible for publishing checkpoint request to a replica shard.

Opensearch.internal:

Nested Class Summary

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

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.opensearch.action.IndicesRequest

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.action.support.replication.ReplicationRequest

DEFAULT_TIMEOUT, index, shardId, timeout, waitForActiveShards

Constructor Summary

Constructors

Constructor	Description
PublishCheckpointRequest(StreamInput in)
PublishCheckpointRequest(ReplicationCheckpoint checkpoint)

Method Summary

Modifier and Type	Method	Description
ReplicationCheckpoint	getCheckpoint()	Returns Replication Checkpoint
String	toString()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.action.support.replication.ReplicationRequest

createTask, getDescription, index, index, indices, indicesOptions, onRetry, routedBasedOnClusterVersion, shardId, timeout, timeout, timeout, validate, waitForActiveShards, waitForActiveShards, waitForActiveShards, writeThin

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

setParentTask

Constructor Details

PublishCheckpointRequest

public PublishCheckpointRequest(ReplicationCheckpoint checkpoint)

PublishCheckpointRequest

public PublishCheckpointRequest(StreamInput in)
                         throws IOException

Throws:

IOException

Method Details

getCheckpoint

public ReplicationCheckpoint getCheckpoint()

Returns Replication Checkpoint

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 ReplicationRequest<PublishCheckpointRequest>

Throws:

IOException

toString

public String toString()

Specified by:

toString in class ReplicationRequest<PublishCheckpointRequest>