com.tencentcloudapi.common

Class AbstractClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

Direct Known Subclasses:

AaiClient, AcaClient, AcpClient, AdvisorClient, AfcClient, AfClient, AiartClient, AmeClient, AmsClient, AmsClient, AnicloudClient, AntiddosClient, ApeClient, ApiClient, ApigatewayClient, ApmClient, AsClient, AsrClient, AswClient, BaClient, BatchClient, BdaClient, BhClient, BiClient, BillingClient, BizliveClient, BmaClient, BmaClient, BmClient, BmeipClient, BmlbClient, BmvpcClient, BpaasClient, BriClient, BscaClient, BtoeClient, BtoeClient, CaClient, CamClient, CaptchaClient, CarClient, CatClient, CbsClient, CccClient, CdbClient, CdcClient, CdnClient, CdsClient, CdwchClient, CdwdorisClient, CdwpgClient, CdzClient, CfgClient, CfsClient, CfwClient, ChcClient, ChdfsClient, ChdfsClient, CiamClient, CiiClient, CiiClient, CimClient, CisClient, CkafkaClient, ClbClient, CloudappClient, CloudauditClient, CloudhsmClient, CloudstudioClient, ClsClient, CmeClient, CmqClient, CmsClient, CommonClient, ConfigClient, ControlcenterClient, CpdpClient, CsipClient, CsxgClient, CvmClient, CwpClient, CwsClient, CynosdbClient, DasbClient, DataintegrationClient, DayuClient, DbbrainClient, DbbrainClient, DbdcClient, DcClient, DcdbClient, DlcClient, DnspodClient, DomainClient, DrmClient, DsClient, DsgcClient, DtfClient, DtsClient, DtsClient, EbClient, EccClient, EcdnClient, EcmClient, EiamClient, EisClient, EisClient, EmrClient, EsClient, EsClient, EssbasicClient, EssbasicClient, EssClient, FacefusionClient, FacefusionClient, FaceidClient, FmuClient, FtClient, GaapClient, GmeClient, GoosefsClient, GpmClient, GsClient, GseClient, GwlbClient, HaboClient, HaiClient, HasimClient, HcmClient, HunyuanClient, IaiClient, IaiClient, IapClient, IcClient, IcrClient, IeClient, IecpClient, IgClient, IirClient, ImsClient, ImsClient, IoaClient, IotClient, IotcloudClient, IotcloudClient, IotexplorerClient, IottidClient, IotvideoClient, IotvideoClient, IotvideoClient, IotvideoindustryClient, IrpClient, IrpClient, IssClient, IvldClient, KeewidbClient, KmsClient, LcicClient, LighthouseClient, LiveClient, LkeapClient, LkeClient, LowcodeClient, MallClient, MariadbClient, MarketClient, MemcachedClient, MgobeClient, MgobeClient, MmpsClient, MnaClient, MongodbClient, MongodbClient, MonitorClient, MonitorClient, MpsClient, MqttClient, MrsClient, MsClient, MspClient, MvjClient, NlpClient, NppClient, OceanusClient, OcrClient, OmicsClient, OrganizationClient, OrganizationClient, PartnersClient, PdsClient, PostgresClient, PrivatednsClient, PtsClient, RceClient, RedisClient, RegionClient, RumClient, ScfClient, SesClient, SmhClient, SmopClient, SmpnClient, SmsClient, SmsClient, SoeClient, SolarClient, SqlserverClient, SsaClient, SslClient, SslpodClient, SsmClient, StsClient, SvpClient, TafClient, TagClient, TanClient, TatClient, TavClient, TbaasClient, TbmClient, TbpClient, TbpClient, TcaplusdbClient, TcbClient, TcbrClient, TccatalogClient, TcexClient, TchdClient, TciClient, TcmClient, TcrClient, TcssClient, TdcpgClient, TdidClient, TdmqClient, TdsClient, TemClient, TemClient, TeoClient, TeoClient, ThpcClient, ThpcClient, ThpcClient, TiaClient, TicClient, TicmClient, TicsClient, TiemsClient, TiiaClient, TioneClient, TioneClient, TiwClient, TkeClient, TkeClient, TkgdqClient, TmsClient, TmsClient, TmtClient, TourismClient, TrabbitClient, TrdpClient, TrocketClient, TrpClient, TrroClient, TrtcClient, TseClient, TsfClient, TsiClient, TswClient, TswClient, TtsClient, UmpClient, VcgClient, VclmClient, VcubeClient, VdbClient, VmClient, VmClient, VmClient, VmsClient, VodClient, VodClient, VpcClient, VrsClient, VtcClient, WafClient, WavClient, WedataClient, WeilingwithClient, WssClient, YinsudaClient, YoumallClient, YunjingClient, YunsouClient, YunsouClient

public abstract class AbstractClient
extends Object

AbstractClient provides the basic functionalities for interacting with Tencent Cloud services. It handles request signing, sending, and response processing.

Field Summary

Fields

Modifier and Type	Field and Description
com.google.gson.Gson	gson
static int	HTTP_RSP_OK
static String	SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
AbstractClient(String endpoint, String version, Credential credential, String region) Constructor for AbstractClient with default client profile.
AbstractClient(String endpoint, String version, Credential credential, String region, ClientProfile profile) Constructor for AbstractClient with a custom client profile.

Method Summary

Modifier and Type	Method and Description
String	call(String action, String jsonPayload) Calls an API action with JSON payload using the TC3-HMAC-SHA256 signature.
String	callOctetStream(String action, HashMap<String,String> headers, byte[] body) Calls an API action with binary payload using the TC3-HMAC-SHA256 signature.
ClientProfile	getClientProfile() Gets the client profile.
Credential	getCredential() Gets the credential.
String	getRegion() Gets the region.
CircuitBreaker	getRegionBreaker()
protected String	internalRequest(AbstractModel request, String actionName) Executes an API request and returns the raw string response.
protected <T> T	internalRequest(AbstractModel request, String actionName, Class<T> typeOfT) Executes an API request and returns the deserialized response object.
protected okhttp3.Response	internalRequestRaw(AbstractModel request, String actionName) Executes the raw API request and returns the HTTP Response object.
protected <T> T	processResponseJson(okhttp3.Response resp, Class<T> typeOfT, CircuitBreaker.Token breakerToken) Processes a JSON response.
protected <T> T	processResponseSSE(okhttp3.Response resp, Class<T> typeOfT, CircuitBreaker.Token breakerToken) Processes a Server-Sent Events (SSE) response.
Object	retry(AbstractModel req, int retryTimes) 请注意购买类接口谨慎调用，可能导致多次购买 仅幂等接口推荐使用
void	setClientProfile(ClientProfile profile) Sets the client profile.
void	setCredential(Credential credential) Sets the credential.
void	setRegion(String region) Sets the region.
void	setRegionBreaker(CircuitBreaker regionBreaker)

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_RSP_OK

public static final int HTTP_RSP_OK

See Also:

Constant Field Values

SDK_VERSION

public static final String SDK_VERSION

See Also:

Constant Field Values

gson

public com.google.gson.Gson gson

Constructor Detail

AbstractClient

public AbstractClient(String endpoint,
                      String version,
                      Credential credential,
                      String region)

Constructor for AbstractClient with default client profile.

Parameters:

endpoint - API endpoint URL.

version - API version.

credential - User credentials.

region - Region.

AbstractClient

public AbstractClient(String endpoint,
                      String version,
                      Credential credential,
                      String region,
                      ClientProfile profile)

Constructor for AbstractClient with a custom client profile.

Parameters:

endpoint - API endpoint URL.

version - API version.

credential - User credentials.

region - Region.

profile - Client configuration profile.

Method Detail

getRegion

public String getRegion()

Gets the region.

Returns:

The region.

setRegion

public void setRegion(String region)

Sets the region.

Parameters:

region - The region to set.

getClientProfile

public ClientProfile getClientProfile()

Gets the client profile.

Returns:

The client profile.

setClientProfile

public void setClientProfile(ClientProfile profile)

Sets the client profile.

Parameters:

profile - The client profile to set.

getCredential

public Credential getCredential()

Gets the credential.

Returns:

The credential.

setCredential

public void setCredential(Credential credential)

Sets the credential.

Parameters:

credential - The credential to set.

call

public String call(String action,
                   String jsonPayload)
            throws TencentCloudSDKException

Calls an API action with JSON payload using the TC3-HMAC-SHA256 signature. Ignores the request method and signature method defined in the profile.

Parameters:

action - Name of the API action.

jsonPayload - JSON string containing the request parameters.

Returns:

Raw response from the API.

Throws:

TencentCloudSDKException - If an error occurs during the API call.

callOctetStream

public String callOctetStream(String action,
                              HashMap<String,String> headers,
                              byte[] body)
                       throws TencentCloudSDKException

Calls an API action with binary payload using the TC3-HMAC-SHA256 signature. Ignores the request method and signature method defined in the profile.

Parameters:

action - Name of the API action.

headers - HTTP headers to include in the request.

body - Binary payload (octet-stream).

Returns:

Raw response from the API.

Throws:

TencentCloudSDKException - If an error occurs during the API call.

internalRequest

protected String internalRequest(AbstractModel request,
                                 String actionName)
                          throws TencentCloudSDKException

Executes an API request and returns the raw string response. Handles circuit breaking for region failover.

Parameters:

request - The request object containing API parameters.

actionName - The name of the API action to be called.

Returns:

The raw string response from the API.

Throws:

TencentCloudSDKException - If an error occurs during the API call.

internalRequest

protected <T> T internalRequest(AbstractModel request,
                                String actionName,
                                Class<T> typeOfT)
                         throws TencentCloudSDKException

Executes an API request and returns the deserialized response object. Handles circuit breaking for region failover.

Type Parameters:

T - The type of the response object.

Parameters:

request - The request object containing API parameters.

actionName - The name of the API action to be called.

typeOfT - The class of the response object to deserialize to.

Returns:

The deserialized response object.

Throws:

TencentCloudSDKException - If an error occurs during the API call.

processResponseSSE

protected <T> T processResponseSSE(okhttp3.Response resp,
                                   Class<T> typeOfT,
                                   CircuitBreaker.Token breakerToken)
                            throws TencentCloudSDKException

Processes a Server-Sent Events (SSE) response.

Type Parameters:

T - The type of the response model.

Parameters:

resp - The raw HTTP response.

typeOfT - The class of the response model.

breakerToken - The circuit breaker token.

Returns:

The SSE response model.

Throws:

TencentCloudSDKException - If an error occurs during processing.

processResponseJson

protected <T> T processResponseJson(okhttp3.Response resp,
                                    Class<T> typeOfT,
                                    CircuitBreaker.Token breakerToken)
                             throws TencentCloudSDKException

Processes a JSON response.

Type Parameters:

T - The type of the response object.

Parameters:

resp - The raw HTTP response.

typeOfT - The class of the response object to deserialize to.

breakerToken - The circuit breaker token.

Returns:

The deserialized response object.

Throws:

TencentCloudSDKException - If an error occurs during processing.

internalRequestRaw

protected okhttp3.Response internalRequestRaw(AbstractModel request,
                                              String actionName)
                                       throws TencentCloudSDKException,
                                              IOException

Executes the raw API request and returns the HTTP Response object.

Parameters:

request - The request object containing API parameters.

actionName - The name of the API action to be called.

Returns:

The raw HTTP Response object.

Throws:

TencentCloudSDKException - If an error occurs during the API call.

IOException - If an I/O error occurs.

retry

public Object retry(AbstractModel req,
                    int retryTimes)
             throws TencentCloudSDKException

请注意购买类接口谨慎调用，可能导致多次购买 仅幂等接口推荐使用

Parameters:

req -

retryTimes -

Throws:

TencentCloudSDKException

getRegionBreaker

public CircuitBreaker getRegionBreaker()

setRegionBreaker

public void setRegionBreaker(CircuitBreaker regionBreaker)