com.tencentcloudapi.common.profile

Class ClientProfile

java.lang.Object

com.tencentcloudapi.common.profile.ClientProfile

public class ClientProfile
extends Object

ClientProfile represents the profile configuration for a client in terms of signature methods, HTTP profile, language settings, and other configurations for interacting with Tencent Cloud APIs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SIGN_SHA1 Constant for signature process using HmacSHA1 (version 1).
static String	SIGN_SHA256 Constant for signature process using HmacSHA256 (version 1).
static String	SIGN_TC3_256 Constant for signature process using TC3-HMAC-SHA256 (version 3).

Constructor Summary

Constructors

Constructor and Description
ClientProfile() Default constructor which initializes the ClientProfile with the default signing method "TC3-HMAC-SHA256" and a default HTTP profile.
ClientProfile(String signMethod) Constructor to initialize ClientProfile with a specific signing method.
ClientProfile(String signMethod, HttpProfile httpProfile) Constructor to initialize ClientProfile with a specific signing method and HTTP profile.

Method Summary

Modifier and Type	Method and Description
String	getBackupEndpoint() Getter for the backup endpoint, used when the primary endpoint is unavailable.
HttpProfile	getHttpProfile() Getter for the HTTP profile associated with the client.
Language	getLanguage() Getter for the language setting of the client.
String	getSignMethod() Getter for the signature method used in API requests.
boolean	isDebug() Getter for the debug flag, which indicates whether debugging is enabled.
boolean	isUnsignedPayload() Getter for the flag indicating whether the payload is ignored during signing.
void	setBackupEndpoint(String backupEndpoint) Setter for the backup endpoint.
void	setDebug(boolean debug) Setter for the debug flag, enabling or disabling debugging.
void	setHttpProfile(HttpProfile httpProfile) Setter for the HTTP profile associated with the client.
void	setLanguage(Language lang) Setter for the language setting of the client.
void	setSignMethod(String signMethod) Setter for the signature method used in API requests.
void	setUnsignedPayload(boolean flag) Setter for the flag indicating whether the payload should be ignored during signing.

Methods inherited from class java.lang.Object

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

Field Detail

SIGN_SHA1

public static final String SIGN_SHA1

Constant for signature process using HmacSHA1 (version 1). This is an older signature method for API requests.

See Also:

Constant Field Values

SIGN_SHA256

public static final String SIGN_SHA256

Constant for signature process using HmacSHA256 (version 1). This is a more secure signature method for API requests.

See Also:

Constant Field Values

SIGN_TC3_256

public static final String SIGN_TC3_256

Constant for signature process using TC3-HMAC-SHA256 (version 3). This is the latest and most secure signature method for API requests.

See Also:

Constant Field Values

Constructor Detail

ClientProfile

public ClientProfile(String signMethod,
                     HttpProfile httpProfile)

Constructor to initialize ClientProfile with a specific signing method and HTTP profile. If the signing method is null or empty, it defaults to "TC3-HMAC-SHA256".

Parameters:

signMethod - The method used for signing the request (e.g., HmacSHA1, HmacSHA256, TC3-HMAC-SHA256).

httpProfile - The HTTP profile containing endpoint and connection settings.

ClientProfile

public ClientProfile(String signMethod)

Constructor to initialize ClientProfile with a specific signing method. Initializes the HTTP profile to a default new instance.

Parameters:

signMethod - The method used for signing the request (e.g., HmacSHA1, HmacSHA256, TC3-HMAC-SHA256).

ClientProfile

public ClientProfile()

Default constructor which initializes the ClientProfile with the default signing method "TC3-HMAC-SHA256" and a default HTTP profile.

Method Detail

getSignMethod

public String getSignMethod()

Getter for the signature method used in API requests.

Returns:

The signature method (e.g., HmacSHA1, HmacSHA256, TC3-HMAC-SHA256).

setSignMethod

public void setSignMethod(String signMethod)

Setter for the signature method used in API requests.

Parameters:

signMethod - The signature method (e.g., HmacSHA1, HmacSHA256, TC3-HMAC-SHA256).

getHttpProfile

public HttpProfile getHttpProfile()

Getter for the HTTP profile associated with the client.

Returns:

The HTTP profile containing endpoint and connection settings.

setHttpProfile

public void setHttpProfile(HttpProfile httpProfile)

Setter for the HTTP profile associated with the client.

Parameters:

httpProfile - The new HTTP profile to be set.

isUnsignedPayload

public boolean isUnsignedPayload()

Getter for the flag indicating whether the payload is ignored during signing.

Returns:

true if the payload is ignored during signing, false otherwise.

setUnsignedPayload

public void setUnsignedPayload(boolean flag)

Setter for the flag indicating whether the payload should be ignored during signing. This is only relevant for POST requests.

Parameters:

flag - Set to true if the payload should be ignored, false otherwise.

getLanguage

public Language getLanguage()

Getter for the language setting of the client.

Returns:

The current language setting (e.g., zh-CN, en-US).

setLanguage

public void setLanguage(Language lang)

Setter for the language setting of the client.

Parameters:

lang - The language to set (e.g., zh-CN, en-US).

isDebug

public boolean isDebug()

Getter for the debug flag, which indicates whether debugging is enabled.

Returns:

true if debugging is enabled, false otherwise.

setDebug

public void setDebug(boolean debug)

Setter for the debug flag, enabling or disabling debugging.

Parameters:

debug - Set to true to enable debugging, false to disable.

getBackupEndpoint

public String getBackupEndpoint()

Getter for the backup endpoint, used when the primary endpoint is unavailable.

Returns:

The backup endpoint URL.

setBackupEndpoint

public void setBackupEndpoint(String backupEndpoint)

Setter for the backup endpoint.

Parameters:

backupEndpoint - The backup endpoint URL to be set.