com.tencentcloudapi.ecm.v20190719.models

Class HealthCheck

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ecm.v20190719.models.HealthCheck

public class HealthCheck
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
HealthCheck()
HealthCheck(HealthCheck source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
Long	getCheckPort() Get Health check port (a custom check parameter), which is the port of the real server by default.
String	getCheckType() Get Health check protocol (a custom check parameter).
String	getContextType() Get Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`.
Long	getHealthNum() Get Health threshold.
Long	getHealthSwitch() Get Whether to enable health check.
Long	getIntervalTime() Get Health check interval in seconds.
String	getRecvContext() Get Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`.
String	getSendContext() Get Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`.
Long	getTimeOut() Get Health check response timeout period in seconds.
Long	getUnHealthyNum() Get Unhealthy threshold.
void	setCheckPort(Long CheckPort) Set Health check port (a custom check parameter), which is the port of the real server by default.
void	setCheckType(String CheckType) Set Health check protocol (a custom check parameter).
void	setContextType(String ContextType) Set Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`.
void	setHealthNum(Long HealthNum) Set Health threshold.
void	setHealthSwitch(Long HealthSwitch) Set Whether to enable health check.
void	setIntervalTime(Long IntervalTime) Set Health check interval in seconds.
void	setRecvContext(String RecvContext) Set Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`.
void	setSendContext(String SendContext) Set Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`.
void	setTimeOut(Long TimeOut) Set Health check response timeout period in seconds.
void	setUnHealthyNum(Long UnHealthyNum) Set Unhealthy threshold.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheck

public HealthCheck()

HealthCheck

public HealthCheck(HealthCheck source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getHealthSwitch

public Long getHealthSwitch()

Get Whether to enable health check. Valid values: 1: enable; 0: disable Note: this field may return null, indicating that no valid values can be obtained.

Returns:

HealthSwitch Whether to enable health check. Valid values: 1: enable; 0: disable Note: this field may return null, indicating that no valid values can be obtained.

setHealthSwitch

public void setHealthSwitch(Long HealthSwitch)

Set Whether to enable health check. Valid values: 1: enable; 0: disable Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

HealthSwitch - Whether to enable health check. Valid values: 1: enable; 0: disable Note: this field may return null, indicating that no valid values can be obtained.

getTimeOut

public Long getTimeOut()

Get Health check response timeout period in seconds. Value range: 2–60. Default value: 2. The value of this parameter should be smaller than the check interval. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

TimeOut Health check response timeout period in seconds. Value range: 2–60. Default value: 2. The value of this parameter should be smaller than the check interval. Note: this field may return null, indicating that no valid values can be obtained.

setTimeOut

public void setTimeOut(Long TimeOut)

Set Health check response timeout period in seconds. Value range: 2–60. Default value: 2. The value of this parameter should be smaller than the check interval. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

TimeOut - Health check response timeout period in seconds. Value range: 2–60. Default value: 2. The value of this parameter should be smaller than the check interval. Note: this field may return null, indicating that no valid values can be obtained.

getIntervalTime

public Long getIntervalTime()

Get Health check interval in seconds. Value range: 5–300. Default value: 5. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

IntervalTime Health check interval in seconds. Value range: 5–300. Default value: 5. Note: this field may return null, indicating that no valid values can be obtained.

setIntervalTime

public void setIntervalTime(Long IntervalTime)

Set Health check interval in seconds. Value range: 5–300. Default value: 5. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

IntervalTime - Health check interval in seconds. Value range: 5–300. Default value: 5. Note: this field may return null, indicating that no valid values can be obtained.

getHealthNum

public Long getHealthNum()

Get Health threshold. Value range: 2–10. Default value: 3, indicating that if a forward is found healthy three consecutive times, it will be considered normal. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

HealthNum Health threshold. Value range: 2–10. Default value: 3, indicating that if a forward is found healthy three consecutive times, it will be considered normal. Note: this field may return null, indicating that no valid values can be obtained.

setHealthNum

public void setHealthNum(Long HealthNum)

Set Health threshold. Value range: 2–10. Default value: 3, indicating that if a forward is found healthy three consecutive times, it will be considered normal. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

HealthNum - Health threshold. Value range: 2–10. Default value: 3, indicating that if a forward is found healthy three consecutive times, it will be considered normal. Note: this field may return null, indicating that no valid values can be obtained.

getUnHealthyNum

public Long getUnHealthyNum()

Get Unhealthy threshold. Value range: 2–10. Default value: 3, indicating that if a forward is found unhealthy three consecutive times, it will be considered exceptional. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

UnHealthyNum Unhealthy threshold. Value range: 2–10. Default value: 3, indicating that if a forward is found unhealthy three consecutive times, it will be considered exceptional. Note: this field may return null, indicating that no valid values can be obtained.

setUnHealthyNum

public void setUnHealthyNum(Long UnHealthyNum)

Set Unhealthy threshold. Value range: 2–10. Default value: 3, indicating that if a forward is found unhealthy three consecutive times, it will be considered exceptional. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

UnHealthyNum - Unhealthy threshold. Value range: 2–10. Default value: 3, indicating that if a forward is found unhealthy three consecutive times, it will be considered exceptional. Note: this field may return null, indicating that no valid values can be obtained.

getCheckPort

public Long getCheckPort()

Get Health check port (a custom check parameter), which is the port of the real server by default. Unless you want to specify a port, we recommend you leave it empty. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

CheckPort Health check port (a custom check parameter), which is the port of the real server by default. Unless you want to specify a port, we recommend you leave it empty. Note: this field may return null, indicating that no valid values can be obtained.

setCheckPort

public void setCheckPort(Long CheckPort)

Set Health check port (a custom check parameter), which is the port of the real server by default. Unless you want to specify a port, we recommend you leave it empty. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

CheckPort - Health check port (a custom check parameter), which is the port of the real server by default. Unless you want to specify a port, we recommend you leave it empty. Note: this field may return null, indicating that no valid values can be obtained.

getContextType

public String getContextType()

Get Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`. This parameter represents the input format of the health check. Valid values: HEX, TEXT. If the value is `HEX`, the characters of `SendContext` and `RecvContext` can only be selected from `0123456789ABCDEF`, and the length must be an even number. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ContextType Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`. This parameter represents the input format of the health check. Valid values: HEX, TEXT. If the value is `HEX`, the characters of `SendContext` and `RecvContext` can only be selected from `0123456789ABCDEF`, and the length must be an even number. Note: this field may return null, indicating that no valid values can be obtained.

setContextType

public void setContextType(String ContextType)

Set Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`. This parameter represents the input format of the health check. Valid values: HEX, TEXT. If the value is `HEX`, the characters of `SendContext` and `RecvContext` can only be selected from `0123456789ABCDEF`, and the length must be an even number. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ContextType - Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`. This parameter represents the input format of the health check. Valid values: HEX, TEXT. If the value is `HEX`, the characters of `SendContext` and `RecvContext` can only be selected from `0123456789ABCDEF`, and the length must be an even number. Note: this field may return null, indicating that no valid values can be obtained.

getSendContext

public String getSendContext()

Get Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`. This parameter represents the content of the request sent by the health check. It can contain up to 500 visible ASCII characters. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

SendContext Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`. This parameter represents the content of the request sent by the health check. It can contain up to 500 visible ASCII characters. Note: this field may return null, indicating that no valid values can be obtained.

setSendContext

public void setSendContext(String SendContext)

Set Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`. This parameter represents the content of the request sent by the health check. It can contain up to 500 visible ASCII characters. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

SendContext - Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`. This parameter represents the content of the request sent by the health check. It can contain up to 500 visible ASCII characters. Note: this field may return null, indicating that no valid values can be obtained.

getRecvContext

public String getRecvContext()

Get Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`. This parameter represents the result returned by the health check. It can contain up to 500 visible ASCII characters. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

RecvContext Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`. This parameter represents the result returned by the health check. It can contain up to 500 visible ASCII characters. Note: this field may return null, indicating that no valid values can be obtained.

setRecvContext

public void setRecvContext(String RecvContext)

Set Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`. This parameter represents the result returned by the health check. It can contain up to 500 visible ASCII characters. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

RecvContext - Health check protocol (a custom check parameter), which is required if the value of `CheckType` is `CUSTOM`. This parameter represents the result returned by the health check. It can contain up to 500 visible ASCII characters. Note: this field may return null, indicating that no valid values can be obtained.

getCheckType

public String getCheckType()

Get Health check protocol (a custom check parameter). Valid values: TCP, CUSTOM (applicable only to UDP listeners. If custom health check is used, this parameter will be required). Note: this field may return null, indicating that no valid values can be obtained.

Returns:

CheckType Health check protocol (a custom check parameter). Valid values: TCP, CUSTOM (applicable only to UDP listeners. If custom health check is used, this parameter will be required). Note: this field may return null, indicating that no valid values can be obtained.

setCheckType

public void setCheckType(String CheckType)

Set Health check protocol (a custom check parameter). Valid values: TCP, CUSTOM (applicable only to UDP listeners. If custom health check is used, this parameter will be required). Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

CheckType - Health check protocol (a custom check parameter). Valid values: TCP, CUSTOM (applicable only to UDP listeners. If custom health check is used, this parameter will be required). Note: this field may return null, indicating that no valid values can be obtained.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel