Package org.apache.kafka.server.log.remote.storage

Class RemoteLogSegmentMetadata

java.lang.Object

org.apache.kafka.server.log.remote.storage.RemoteLogMetadata

org.apache.kafka.server.log.remote.storage.RemoteLogSegmentMetadata

@Evolving
public class RemoteLogSegmentMetadata
extends RemoteLogMetadata

It describes the metadata about a topic partition's remote log segment in the remote storage. This is uniquely represented with RemoteLogSegmentId.

New instance is always created with the state as RemoteLogSegmentState.COPY_SEGMENT_STARTED. This can be updated by applying RemoteLogSegmentMetadataUpdate for the respective RemoteLogSegmentId of the RemoteLogSegmentMetadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoteLogSegmentMetadata.CustomMetadata	Custom metadata from a RemoteStorageManager plugin.

Constructor Summary

Constructors

Constructor	Description
RemoteLogSegmentMetadata(RemoteLogSegmentId remoteLogSegmentId, long startOffset, long endOffset, long maxTimestampMs, int brokerId, long eventTimestampMs, int segmentSizeInBytes, Map<Integer,Long> segmentLeaderEpochs)	Creates an instance with the given metadata of remote log segment and its state as RemoteLogSegmentState.COPY_SEGMENT_STARTED.
RemoteLogSegmentMetadata(RemoteLogSegmentId remoteLogSegmentId, long startOffset, long endOffset, long maxTimestampMs, int brokerId, long eventTimestampMs, int segmentSizeInBytes, Optional<RemoteLogSegmentMetadata.CustomMetadata> customMetadata, RemoteLogSegmentState state, Map<Integer,Long> segmentLeaderEpochs)	Creates an instance with the given metadata of remote log segment.

Method Summary

Modifier and Type	Method	Description
RemoteLogSegmentMetadata	createWithUpdates(RemoteLogSegmentMetadataUpdate rlsmUpdate)	Creates a new RemoteLogSegmentMetadata applying the given rlsmUpdate on this instance.
Optional<RemoteLogSegmentMetadata.CustomMetadata>	customMetadata()
long	endOffset()
boolean	equals(Object o)
int	hashCode()
long	maxTimestampMs()
RemoteLogSegmentId	remoteLogSegmentId()
NavigableMap<Integer,Long>	segmentLeaderEpochs()
int	segmentSizeInBytes()
long	startOffset()
RemoteLogSegmentState	state()	Returns the current state of this remote log segment.
TopicIdPartition	topicIdPartition()
String	toString()

Methods inherited from class org.apache.kafka.server.log.remote.storage.RemoteLogMetadata

brokerId, eventTimestampMs

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RemoteLogSegmentMetadata

public RemoteLogSegmentMetadata(RemoteLogSegmentId remoteLogSegmentId,
 long startOffset,
 long endOffset,
 long maxTimestampMs,
 int brokerId,
 long eventTimestampMs,
 int segmentSizeInBytes,
 Optional<RemoteLogSegmentMetadata.CustomMetadata> customMetadata,
 RemoteLogSegmentState state,
 Map<Integer,Long> segmentLeaderEpochs)

Creates an instance with the given metadata of remote log segment.

segmentLeaderEpochs can not be empty. If all the records in this segment belong to the same leader epoch then it should have an entry with epoch mapping to start-offset of this segment.

Parameters:

remoteLogSegmentId - Universally unique remote log segment id.

startOffset - Start offset of this segment (inclusive).

endOffset - End offset of this segment (inclusive).

maxTimestampMs - Maximum timestamp in milli seconds in this segment.

brokerId - Broker id from which this event is generated.

eventTimestampMs - Epoch time in milli seconds at which the remote log segment is copied to the remote tier storage.

segmentSizeInBytes - Size of this segment in bytes.

customMetadata - Custom metadata.

state - State of the respective segment of remoteLogSegmentId.

segmentLeaderEpochs - leader epochs occurred within this segment.

RemoteLogSegmentMetadata

public RemoteLogSegmentMetadata(RemoteLogSegmentId remoteLogSegmentId,
 long startOffset,
 long endOffset,
 long maxTimestampMs,
 int brokerId,
 long eventTimestampMs,
 int segmentSizeInBytes,
 Map<Integer,Long> segmentLeaderEpochs)

Creates an instance with the given metadata of remote log segment and its state as RemoteLogSegmentState.COPY_SEGMENT_STARTED.

segmentLeaderEpochs can not be empty. If all the records in this segment belong to the same leader epoch then it should have an entry with epoch mapping to start-offset of this segment.

Parameters:

remoteLogSegmentId - Universally unique remote log segment id.

startOffset - Start offset of this segment (inclusive).

endOffset - End offset of this segment (inclusive).

maxTimestampMs - Maximum timestamp in this segment

brokerId - Broker id from which this event is generated.

eventTimestampMs - Epoch time in milli seconds at which the remote log segment is copied to the remote tier storage.

segmentSizeInBytes - Size of this segment in bytes.

segmentLeaderEpochs - leader epochs occurred within this segment

Method Details

remoteLogSegmentId

public RemoteLogSegmentId remoteLogSegmentId()

Returns:

unique id of this segment.

startOffset

public long startOffset()

Returns:

Start offset of this segment (inclusive).

endOffset

public long endOffset()

Returns:

End offset of this segment (inclusive).

segmentSizeInBytes

public int segmentSizeInBytes()

Returns:

Total size of this segment in bytes.

maxTimestampMs

public long maxTimestampMs()

Returns:

Maximum timestamp in milli seconds of a record within this segment.

segmentLeaderEpochs

public NavigableMap<Integer,Long> segmentLeaderEpochs()

Returns:

Map of leader epoch vs offset for the records available in this segment.

customMetadata

public Optional<RemoteLogSegmentMetadata.CustomMetadata> customMetadata()

Returns:

Custom metadata.

state

public RemoteLogSegmentState state()

Returns the current state of this remote log segment. It can be any of the below

RemoteLogSegmentState.COPY_SEGMENT_STARTED RemoteLogSegmentState.COPY_SEGMENT_FINISHED RemoteLogSegmentState.DELETE_SEGMENT_STARTED RemoteLogSegmentState.DELETE_SEGMENT_FINISHED

createWithUpdates

public RemoteLogSegmentMetadata createWithUpdates(RemoteLogSegmentMetadataUpdate rlsmUpdate)

Creates a new RemoteLogSegmentMetadata applying the given rlsmUpdate on this instance. This method will not update this instance.

Parameters:

rlsmUpdate - update to be applied.

Returns:

a new instance created by applying the given update on this instance.

topicIdPartition

public TopicIdPartition topicIdPartition()

Specified by:

topicIdPartition in class RemoteLogMetadata

Returns:

TopicIdPartition for which this event is generated.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object