Config クラスは、Client オブジェクトを構築するために必要なすべての接続パラメーターをカプセル化します。OpenSearch Retrieval Engine Edition インスタンスへの接続を確立するには、設定済みの Config インスタンスを Client コンストラクターに渡します。
スレッドセーフ性： スレッドセーフ
コンストラクター
Config()パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
endpoint | String | API エンドポイントです。API エンドポイント タブの インスタンスの詳細 ページで確認できます。 |
instanceId | String | OpenSearch インスタンスの ID です。インスタンスの詳細 ページで確認できます。 |
accessUserName | String | ユーザー名です。ネットワーク情報 タブの インスタンスの詳細 ページで確認できます。 |
accessPassWord | String | パスワードです。ネットワーク情報 タブの インスタンスの詳細 ページで確認できます。 |
httpProxy | String | パブリック IP アドレスです。インターネット経由で API オペレーションを呼び出す場合のみ必要です。フォーマット： http://<public-ip-address>:<port-number> |
メソッド
setEndpoint
API エンドポイントを設定します。
構文
Config setEndpoint(String endpoint)パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
endpoint | String | API エンドポイントです。API エンドポイント タブの インスタンスの詳細 ページで確認できます。 |
getEndpoint
設定済みの API エンドポイントを返します。
構文
String getEndpoint()戻り値
String — エンドポイントの値。
setInstanceId
インスタンス ID を設定します。
構文
Config setInstanceId(String InstanceId)パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
InstanceId | String | OpenSearch インスタンスの ID です。インスタンスの詳細 ページで確認できます。 |
getInstanceId
設定済みのインスタンス ID を返します。
構文
String getInstanceId()戻り値
String — インスタンス ID の値。
setAccessUserName
認証用のユーザー名を設定します。
構文
Config setAccessUserName(String AccessUserName)パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
AccessUserName | String | ユーザー名です。ネットワーク情報 タブの インスタンスの詳細 ページで確認できます。 |
getAccessUserName
設定済みのユーザー名を返します。
構文
String getAccessUserName()戻り値
String — ユーザー名の値。
setAccessPassWord
認証用のパスワードを設定します。
構文
Config setAccessPassWord(String AccessPassWord)パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
AccessPassWord | String | パスワードです。ネットワーク情報 タブの インスタンスの詳細 ページで確認できます。 |
getAccessPassWord
設定済みのパスワードを返します。
構文
String getAccessPassWord()戻り値
String — パスワードの値。