Skip to content

Commit 4a9caa7

Browse files
committed
Provide detailed comments for the AsyncHttpClient interface
Signed-off-by: Pranit Kumar <pranikum@amazon.com>
1 parent d20abab commit 4a9caa7

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

plugins/repository-s3/src/main/java/org/opensearch/repositories/s3/AsyncHttpClient.java

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,17 @@
1111
import software.amazon.awssdk.http.async.SdkAsyncHttpClient;
1212

1313
/**
14-
* Interface for the AsyncHttpClient to be used by S3 for file uploads.
14+
* An interface for providing the specific implementation of HTTP client used for s3 client.
15+
* <p>
16+
* Implementations are responsible implement the asyncHttpClient method and provide the appropriate Http client
17+
* to be used by s3 clients.
18+
* <p>
19+
* Current supported Http clients are "AwsCrtAsyncHttpClient" and "NettyNioAsyncHttpClient"
1520
*/
1621
public interface AsyncHttpClient {
1722

1823
/**
19-
* method to build the appropriate HttpClient implementations
24+
* Method to build the appropriate HttpClient implementations
2025
* @return SdkAsyncHttpClient
2126
*/
2227
SdkAsyncHttpClient asyncHttpClient();

0 commit comments

Comments
 (0)