Package org.opensearch.indices.recovery

Class StartRecoveryRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.indices.recovery.StartRecoveryRequest

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, TaskAwareRequest

@PublicApi(since="1.0.0")
public class StartRecoveryRequest
extends TransportRequest

Represents a request for starting a peer recovery.

Opensearch.api:

Nested Class Summary

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

TransportRequest.Empty

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
StartRecoveryRequest(org.opensearch.core.common.io.stream.StreamInput in)
StartRecoveryRequest(org.opensearch.core.index.shard.ShardId shardId, String targetAllocationId, DiscoveryNode sourceNode, DiscoveryNode targetNode, Store.MetadataSnapshot metadataSnapshot, boolean primaryRelocation, long recoveryId, long startingSeqNo)	Construct a request for starting a peer recovery.

Method Summary

Modifier and Type	Method	Description
boolean	isPrimaryRelocation()
Store.MetadataSnapshot	metadataSnapshot()
long	recoveryId()
org.opensearch.core.index.shard.ShardId	shardId()
DiscoveryNode	sourceNode()
long	startingSeqNo()
String	targetAllocationId()
DiscoveryNode	targetNode()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

StartRecoveryRequest

public StartRecoveryRequest(org.opensearch.core.common.io.stream.StreamInput in)
                     throws IOException

Throws:

IOException

StartRecoveryRequest

public StartRecoveryRequest(org.opensearch.core.index.shard.ShardId shardId,
 String targetAllocationId,
 DiscoveryNode sourceNode,
 DiscoveryNode targetNode,
 Store.MetadataSnapshot metadataSnapshot,
 boolean primaryRelocation,
 long recoveryId,
 long startingSeqNo)

Construct a request for starting a peer recovery.

Parameters:

shardId - the shard ID to recover

targetAllocationId - the allocation id of the target shard

sourceNode - the source node to remover from

targetNode - the target node to recover to

metadataSnapshot - the Lucene metadata

primaryRelocation - whether or not the recovery is a primary relocation

recoveryId - the recovery ID

startingSeqNo - the starting sequence number

Method Details

recoveryId

public long recoveryId()

shardId

public org.opensearch.core.index.shard.ShardId shardId()

targetAllocationId

public String targetAllocationId()

sourceNode

public DiscoveryNode sourceNode()

targetNode

public DiscoveryNode targetNode()

isPrimaryRelocation

public boolean isPrimaryRelocation()

metadataSnapshot

public Store.MetadataSnapshot metadataSnapshot()

startingSeqNo

public long startingSeqNo()

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class TransportRequest

Throws:

IOException