Skip to content

Commit baa0428

Browse files
committed
Corrected comments and cleaned up variable naming.
Signed-off-by: dblock <dblock@amazon.com>
1 parent a4988a6 commit baa0428

1 file changed

Lines changed: 16 additions & 22 deletions

File tree

java-client/src/main/java/org/opensearch/client/transport/aws/AwsSdk2Transport.java

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -84,49 +84,46 @@ public class AwsSdk2Transport implements OpenSearchTransport {
8484
* Note that asynchronous OpenSearch requests sent through this transport will be dispatched
8585
* *synchronously* on the calling thread.
8686
*
87-
* @param httpClient HTTP client to use for OpenSearch requests.
87+
* @param asyncHttpClient Asynchronous HTTP client to use for OpenSearch requests.
8888
* @param host The fully qualified domain name to connect to.
8989
* @param signingRegion The AWS region for which requests will be signed. This should typically match the region in `host`.
9090
* @param options Options that apply to all requests. Can be null. Create with
9191
* {@link AwsSdk2TransportOptions#builder()} and use these to specify non-default credentials,
9292
* compression options, etc.
9393
*/
9494
public AwsSdk2Transport(
95-
@CheckForNull SdkAsyncHttpClient httpClient,
95+
@CheckForNull SdkAsyncHttpClient asyncHttpClient,
9696
@Nonnull String host,
9797
@Nonnull Region signingRegion,
9898
@CheckForNull AwsSdk2TransportOptions options) {
99-
this(httpClient, host, "es", signingRegion, options);
99+
this(asyncHttpClient, host, "es", signingRegion, options);
100100
}
101101

102102
/**
103103
* Create an {@link OpenSearchTransport} with a synchronous AWS HTTP client.
104-
* <p>
105-
* Note that asynchronous OpenSearch requests sent through this transport will be dispatched
106-
* *synchronously* on the calling thread.
107104
*
108-
* @param httpClient HTTP client to use for OpenSearch requests.
105+
* @param syncHttpClient Synchronous HTTP client to use for OpenSearch requests.
109106
* @param host The fully qualified domain name to connect to.
110107
* @param signingRegion The AWS region for which requests will be signed. This should typically match the region in `host`.
111108
* @param options Options that apply to all requests. Can be null. Create with
112109
* {@link AwsSdk2TransportOptions#builder()} and use these to specify non-default credentials,
113110
* compression options, etc.
114111
*/
115112
public AwsSdk2Transport(
116-
@CheckForNull SdkHttpClient httpClient,
113+
@CheckForNull SdkHttpClient syncHttpClient,
117114
@Nonnull String host,
118115
@Nonnull Region signingRegion,
119116
@CheckForNull AwsSdk2TransportOptions options) {
120-
this(httpClient, host, "es", signingRegion, options);
117+
this(syncHttpClient, host, "es", signingRegion, options);
121118
}
122119

123120
/**
124-
* Create an {@link OpenSearchTransport} with an asynchronous AWS HTTP clients.
121+
* Create an {@link OpenSearchTransport} with an asynchronous AWS HTTP client.
125122
* <p>
126-
* The synchronous client will be used for synchronous OpenSearch requests, and the asynchronous client
127-
* will be used for asynchronous HTTP requests.
123+
* Note that asynchronous OpenSearch requests sent through this transport will be dispatched
124+
* *synchronously* on the calling thread.
128125
*
129-
* @param httpClient HTTP client to use for OpenSearch requests.
126+
* @param asyncHttpClient Asynchronous HTTP client to use for OpenSearch requests.
130127
* @param host The fully qualified domain name to connect to.
131128
* @param signingRegion The AWS region for which requests will be signed. This should typically match the region in `host`.
132129
* @param signingServiceName The AWS signing service name, one of `es` (Amazon OpenSearch) or `aoss` (Amazon OpenSearch Serverless).
@@ -135,21 +132,18 @@ public AwsSdk2Transport(
135132
* compression options, etc.
136133
*/
137134
public AwsSdk2Transport(
138-
@CheckForNull SdkAsyncHttpClient httpClient,
135+
@CheckForNull SdkAsyncHttpClient asyncHttpClient,
139136
@Nonnull String host,
140137
@Nonnull String signingServiceName,
141138
@Nonnull Region signingRegion,
142139
@CheckForNull AwsSdk2TransportOptions options) {
143-
this((SdkAutoCloseable) httpClient, host, signingServiceName, signingRegion, options);
140+
this((SdkAutoCloseable) asyncHttpClient, host, signingServiceName, signingRegion, options);
144141
}
145142

146143
/**
147-
* Create an {@link OpenSearchTransport} with a synchronous AWS HTTP clients.
148-
* <p>
149-
* The synchronous client will be used for synchronous OpenSearch requests, and the asynchronous client
150-
* will be used for asynchronous HTTP requests.
144+
* Create an {@link OpenSearchTransport} with a synchronous AWS HTTP client.
151145
*
152-
* @param httpClient HTTP client to use for OpenSearch requests.
146+
* @param syncHttpClient Synchronous HTTP client to use for OpenSearch requests.
153147
* @param host The fully qualified domain name to connect to.
154148
* @param signingRegion The AWS region for which requests will be signed. This should typically match the region in `host`.
155149
* @param signingServiceName The AWS signing service name, one of `es` (Amazon OpenSearch) or `aoss` (Amazon OpenSearch Serverless).
@@ -158,12 +152,12 @@ public AwsSdk2Transport(
158152
* compression options, etc.
159153
*/
160154
public AwsSdk2Transport(
161-
@CheckForNull SdkHttpClient httpClient,
155+
@CheckForNull SdkHttpClient syncHttpClient,
162156
@Nonnull String host,
163157
@Nonnull String signingServiceName,
164158
@Nonnull Region signingRegion,
165159
@CheckForNull AwsSdk2TransportOptions options) {
166-
this((SdkAutoCloseable) httpClient, host, signingServiceName, signingRegion, options);
160+
this((SdkAutoCloseable) syncHttpClient, host, signingServiceName, signingRegion, options);
167161
}
168162

169163
private AwsSdk2Transport(

0 commit comments

Comments
 (0)