[kafka] branch trunk updated: MINOR: Update the javadoc in RSM (#14352)

[sa...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

satishd pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/trunk by this push:
     new cd897e6c766 MINOR: Update the javadoc in RSM (#14352)
cd897e6c766 is described below

commit cd897e6c766abde8b6fbd7d72d9f202c990131f1
Author: Luke Chen <sh...@gmail.com>
AuthorDate: Thu Sep 7 23:25:11 2023 +0800

    MINOR: Update the javadoc in RSM (#14352)
    
    Reviewers: Satish Duggana <sa...@apache.org>, Kamal Chandraprakash<ka...@gmail.com>
---
 .../kafka/server/log/remote/storage/RemoteStorageManager.java       | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/storage/api/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteStorageManager.java b/storage/api/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteStorageManager.java
index fa819979b2c..9d06617bd66 100644
--- a/storage/api/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteStorageManager.java
+++ b/storage/api/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteStorageManager.java
@@ -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;