root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 3 Packages Projects Releases Wiki Activity

MINOR: Update the javadoc in RSM (#14352) 

Reviewers: Satish Duggana <satishd@apache.org>, Kamal Chandraprakash<kamal.chandraprakash@gmail.com>
This commit is contained in:
Luke Chen 2023-09-07 23:25:11 +08:00 committed by Satish Duggana
parent 5d7840e1b2
commit a5e3f0ded4
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
storage/api/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteStorageManager.java
View File

@ -121,15 +121,15 @@ public interface RemoteStorageManager extends Configurable, Closeable {
/**
* Returns the index for the respective log segment of {@link RemoteLogSegmentMetadata}.
* <p>
* Note: The transaction index may not exist because of no transactional records.
* In this case, it should still return an InputStream with empty content, instead of returning {@code null}.
*
* @param remoteLogSegmentMetadata metadata about the remote log segment.
* @param indexType type of the index to be fetched for the segment.
* @return input stream of the requested index.
* @throws RemoteStorageException if there are any errors while fetching the index.
* @throws RemoteResourceNotFoundException the requested index is not found in the remote storage
* (e.g. Transaction index may not exist because segments created prior to version 2.8.0 will not have transaction index associated with them.).
* The caller of this function are encouraged to re-create the indexes from the segment
* as the suggested way of handling this error if the index is expected to be existed.
*/
InputStream fetchIndex(RemoteLogSegmentMetadata remoteLogSegmentMetadata,
IndexType indexType) throws RemoteStorageException;