com.tencentcloudapi.common

Class CommonClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.common.CommonClient

public class CommonClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
CommonClient(String productName, String version, Credential credential, String region) Constructor to initialize the CommonClient with basic settings.
CommonClient(String productName, String version, Credential credential, String region, ClientProfile profile) Constructor to initialize the CommonClient with custom ClientProfile.

Method Summary

Modifier and Type	Method and Description
String	commonRequest(AbstractModel req, String actionName) Sends a request to Tencent Cloud API with the specified action name.
<T> T	commonRequest(AbstractModel req, String actionName, Class<T> typeOfT) Sends a request to Tencent Cloud API and parses the response into the specified type.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommonClient

public CommonClient(String productName,
                    String version,
                    Credential credential,
                    String region)

Constructor to initialize the CommonClient with basic settings. Uses default ClientProfile settings.

Parameters:

productName - The product name (e.g., "cvm").

version - The API version (e.g., "v1").

credential - The authentication credentials (e.g., API keys).

region - The region to target (e.g., "ap-shanghai").

CommonClient

public CommonClient(String productName,
                    String version,
                    Credential credential,
                    String region,
                    ClientProfile profile)

Constructor to initialize the CommonClient with custom ClientProfile.

Parameters:

productName - The product name (e.g., "cvm").

version - The API version (e.g., "v1").

credential - The authentication credentials (e.g., API keys).

region - The region to target (e.g., "ap-shanghai").

profile - Custom configuration for the client (timeouts, retries, etc.).

Method Detail

commonRequest

public String commonRequest(AbstractModel req,
                            String actionName)
                     throws TencentCloudSDKException

Sends a request to Tencent Cloud API with the specified action name.

Parameters:

req - The request model, containing necessary parameters.

actionName - The API action to perform (e.g., "DescribeInstances").

Returns:

The raw response from the API as a string.

Throws:

TencentCloudSDKException - If the request fails or encounters an error.

commonRequest

public <T> T commonRequest(AbstractModel req,
                           String actionName,
                           Class<T> typeOfT)
                    throws TencentCloudSDKException

Sends a request to Tencent Cloud API and parses the response into the specified type.

Type Parameters:

T - The type of the response model.

Parameters:

req - The request model, containing necessary parameters.

actionName - The API action to perform (e.g., "DescribeInstances").

typeOfT - The class type to deserialize the response into (e.g., ResponseModel.class).

Returns:

The response parsed into the specified type.

Throws:

TencentCloudSDKException - If the request fails or encounters an error.