Package org.opensearch.indices.recovery

Class FileChunkRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.indices.recovery.RecoveryTransportRequest

org.opensearch.indices.recovery.FileChunkRequest

All Implemented Interfaces:

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

public final class FileChunkRequest
extends RecoveryTransportRequest

Request containing a file chunk.

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.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
FileChunkRequest(long recoveryId, long requestSeqNo, org.opensearch.core.index.shard.ShardId shardId, StoreFileMetadata metadata, long position, org.opensearch.core.common.bytes.BytesReference content, boolean lastChunk, int totalTranslogOps, long sourceThrottleTimeInNanos)
FileChunkRequest(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
org.opensearch.core.common.bytes.BytesReference	content()
boolean	lastChunk()	Returns true if this chunk is the last chunk in the stream.
long	length()
StoreFileMetadata	metadata()
String	name()
long	position()
long	recoveryId()
org.opensearch.core.index.shard.ShardId	shardId()
long	sourceThrottleTimeInNanos()
String	toString()
int	totalTranslogOps()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.indices.recovery.RecoveryTransportRequest

requestSeqNo

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, wait, wait, wait

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

FileChunkRequest

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

Throws:

IOException

FileChunkRequest

public FileChunkRequest(long recoveryId,
 long requestSeqNo,
 org.opensearch.core.index.shard.ShardId shardId,
 StoreFileMetadata metadata,
 long position,
 org.opensearch.core.common.bytes.BytesReference content,
 boolean lastChunk,
 int totalTranslogOps,
 long sourceThrottleTimeInNanos)

Method Details

recoveryId

public long recoveryId()

shardId

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

name

public String name()

position

public long position()

length

public long length()

content

public org.opensearch.core.common.bytes.BytesReference content()

totalTranslogOps

public int totalTranslogOps()

sourceThrottleTimeInNanos

public long sourceThrottleTimeInNanos()

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 RecoveryTransportRequest

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

metadata

public StoreFileMetadata metadata()

lastChunk

public boolean lastChunk()

Returns true if this chunk is the last chunk in the stream.