com.tencentcloudapi.common

Class AbstractClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

Direct Known Subclasses:

AaClient, AaiClient, AcpClient, AdvisorClient, AfcClient, AfClient, AiartClient, AmeClient, AmsClient, AmsClient, AnicloudClient, AntiddosClient, ApcasClient, ApeClient, ApiClient, ApigatewayClient, ApmClient, AsClient, AsrClient, AswClient, BaClient, BatchClient, BdaClient, 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, 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, EssbasicClient, EssbasicClient, EssClient, FacefusionClient, FacefusionClient, FaceidClient, FmuClient, FtClient, GaapClient, GmeClient, GoosefsClient, GpmClient, GsClient, GseClient, GwlbClient, HaboClient, HaiClient, HasimClient, HcmClient, HunyuanClient, IaiClient, IaiClient, IcClient, IcrClient, IeClient, IecpClient, IirClient, ImsClient, ImsClient, IoaClient, IotClient, IotcloudClient, IotcloudClient, IotexplorerClient, IottidClient, IotvideoClient, IotvideoClient, IotvideoClient, IotvideoindustryClient, IrpClient, IrpClient, IssClient, IvldClient, KeewidbClient, KmsClient, LcicClient, LighthouseClient, LiveClient, LkeClient, LowcodeClient, LpClient, MallClient, MariadbClient, MarketClient, MemcachedClient, MgobeClient, MgobeClient, MmpsClient, MnaClient, MongodbClient, MongodbClient, MonitorClient, MpsClient, MqttClient, MrsClient, MsClient, MspClient, MvjClient, NlpClient, NppClient, OceanusClient, OcrClient, OmicsClient, OrganizationClient, OrganizationClient, PartnersClient, PdsClient, PostgresClient, PrivatednsClient, PtsClient, RceClient, RedisClient, RegionClient, RkpClient, RpClient, 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, 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, TrdpClient, TrocketClient, TrpClient, TrroClient, TrtcClient, TseClient, TsfClient, TsiClient, TswClient, TswClient, TtsClient, UmpClient, VcgClient, VclmClient, 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

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)
AbstractClient(String endpoint, String version, Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
String	call(String action, String jsonPayload) Use post/json with tc3-hmac-sha256 signature to call any action.
String	callOctetStream(String action, HashMap<String,String> headers, byte[] body) Use post application/octet-stream with tc3-hmac-sha256 signature to call specific action.
ClientProfile	getClientProfile()
Credential	getCredential()
String	getRegion()
CircuitBreaker	getRegionBreaker()
protected String	internalRequest(AbstractModel request, String actionName)
protected <T> T	internalRequest(AbstractModel request, String actionName, Class<T> typeOfT)
protected okhttp3.Response	internalRequestRaw(AbstractModel request, String actionName)
protected <T> T	processResponseJson(okhttp3.Response resp, Class<T> typeOfT, CircuitBreaker.Token breakerToken)
protected <T> T	processResponseSSE(okhttp3.Response resp, Class<T> typeOfT, CircuitBreaker.Token breakerToken)
Object	retry(AbstractModel req, int retryTimes) 请注意购买类接口谨慎调用，可能导致多次购买 仅幂等接口推荐使用
void	setClientProfile(ClientProfile profile)
void	setCredential(Credential credential)
void	setRegion(String 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)

AbstractClient

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

Method Detail

getRegion

public String getRegion()

setRegion

public void setRegion(String region)

getClientProfile

public ClientProfile getClientProfile()

setClientProfile

public void setClientProfile(ClientProfile profile)

getCredential

public Credential getCredential()

setCredential

public void setCredential(Credential credential)

call

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

Use post/json with tc3-hmac-sha256 signature to call any action. Ignore request method and signature method defined in profile.

Parameters:

action - Name of action to be called.

jsonPayload - Parameters of action serialized in json string format.

Returns:

Raw response from API if request succeeded, otherwise an exception will be raised instead of raw response

Throws:

TencentCloudSDKException

callOctetStream

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

Use post application/octet-stream with tc3-hmac-sha256 signature to call specific action. Ignore request method and signature method defined in profile.

Parameters:

action - Name of action to be called.

headers - Parameters of the action, will be put in http header.

body - octet-stream binary body.

Returns:

Raw response from API if request succeeded, otherwise an exception will be raised instead of raw response

Throws:

TencentCloudSDKException

internalRequest

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

Throws:

TencentCloudSDKException

internalRequest

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

Throws:

TencentCloudSDKException

processResponseSSE

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

Throws:

TencentCloudSDKException

processResponseJson

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

Throws:

TencentCloudSDKException

internalRequestRaw

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

Throws:

TencentCloudSDKException

IOException

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)