Overview
This topic describes the Config class and its methods that are used to build the Client object.
Class security
Thread-safe
Constructor
Config()
Parameter description
Parameter | Type | Description |
endpoint | String | The API endpoint. You can view the API endpoint on the API Endpoint tab of the Instance Details page. |
instanceId | String | The ID of the OpenSearch instance. You can view the ID on the Instance Details page. |
accessUserName | String | The username. You can view the username on the Network Information tab of the Instance Details page. |
accessPassWord | String | The password. You can view the password on the Network Information tab of the Instance Details page. |
httpProxy | String | The public IP address. You must specify this parameter for calling API operations over the Internet. Example: "http://Public IP address:Port number". |
setEndpoint method
Syntax
Config setEndpoint(String endpoint)
Parameter description
Parameter | Type | Description |
endpoint | String | The API endpoint. You can view the API endpoint on the API Endpoint tab of the Instance Details page. |
getEndpoint method
Syntax
String getEndpoint()
Response
The API endpoint of the String type
setInstanceId method
Syntax
Config setInstanceId(String InstanceId)
Parameter description
Parameter | Type | Description |
InstanceId | String | The ID of the OpenSearch instance. You can view the ID on the Instance Details page. |
getInstanceId method
Syntax
String getInstanceId()
Response
The instance ID of the String type
setAccessUserName method
Syntax
Config setAccessUserName(String AccessUserName)
Parameter description
Parameter | Type | Description |
AccessUserName | String | The username. You can view the username on the Network Information tab of the Instance Details page. |
getAccessUserName method
Syntax
String getAccessUserName()
Response
The username of the String type
setAccessPassWord method
Syntax
Config setAccessPassWord(String AccessPassWord)
Parameter description
Parameter | Type | Description |
AccessPassWord | String | The password. You can view the password on the Network Information tab of the Instance Details page. |
getAccessPassWord method
Syntax
String getAccessPassWord()
Response
The password of the String type