com.tencentcloudapi.clb.v20180317.models

Class HealthCheck

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.clb.v20180317.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.
String	getExtendedCode() Get GRPC health check status code, which is only applicable to rules with GRPC as the backend forwarding protocol.
Long	getHealthNum() Get Health threshold.
Long	getHealthSwitch() Get Whether to enable health check.
String	getHttpCheckDomain() Get The target domain name for health check.
String	getHttpCheckMethod() Get Health check method (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners).
String	getHttpCheckPath() Get Health check path (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners).
Long	getHttpCode() Get Health check status code (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners).
String	getHttpVersion() Get Health check protocol (a custom check parameter), which is required if the value of CheckType is HTTP.
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	getSourceIpType() Get Specifies the type of IP for health check.
Long	getTimeOut() Get Health check response timeout period in seconds (applicable only to layer-4 listeners).
Long	getUnHealthNum() 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	setExtendedCode(String ExtendedCode) Set GRPC health check status code, which is only applicable to rules with GRPC as the backend forwarding protocol.
void	setHealthNum(Long HealthNum) Set Health threshold.
void	setHealthSwitch(Long HealthSwitch) Set Whether to enable health check.
void	setHttpCheckDomain(String HttpCheckDomain) Set The target domain name for health check.
void	setHttpCheckMethod(String HttpCheckMethod) Set Health check method (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners).
void	setHttpCheckPath(String HttpCheckPath) Set Health check path (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners).
void	setHttpCode(Long HttpCode) Set Health check status code (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners).
void	setHttpVersion(String HttpVersion) Set Health check protocol (a custom check parameter), which is required if the value of CheckType is HTTP.
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	setSourceIpType(Long SourceIpType) Set Specifies the type of IP for health check.
void	setTimeOut(Long TimeOut) Set Health check response timeout period in seconds (applicable only to layer-4 listeners).
void	setUnHealthNum(Long UnHealthNum) 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. 1: enable; 0: disable.

Returns:

HealthSwitch Whether to enable health check. 1: enable; 0: disable.

setHealthSwitch

public void setHealthSwitch(Long HealthSwitch)

Set Whether to enable health check. 1: enable; 0: disable.

Parameters:

HealthSwitch - Whether to enable health check. 1: enable; 0: disable.

getTimeOut

public Long getTimeOut()

Get Health check response timeout period in seconds (applicable only to layer-4 listeners). Value range: 2-60. Default value: 2. This parameter should be less 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 (applicable only to layer-4 listeners). Value range: 2-60. Default value: 2. This parameter should be less 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 (applicable only to layer-4 listeners). Value range: 2-60. Default value: 2. This parameter should be less 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 (applicable only to layer-4 listeners). Value range: 2-60. Default value: 2. This parameter should be less 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. Default value: 3, indicating that if a forward is found healthy three consecutive times, it is considered to be normal. Value range: 2-10 Note: This field may return null, indicating that no valid values can be obtained.

Returns:

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

setHealthNum

public void setHealthNum(Long HealthNum)

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

Parameters:

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

getUnHealthNum

public Long getUnHealthNum()

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

Returns:

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

setUnHealthNum

public void setUnHealthNum(Long UnHealthNum)

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

Parameters:

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

getHttpCode

public Long getHttpCode()

Get Health check status code (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Value range: 1-31. Default value: 31. `1`: Returns code 1xx for healthy status. `2`: Returns code 2xx for healthy status. `4`: Returns code 3xx for healthy status. `8`: Returns code 4xx for healthy status. `16`: Returns code 5xx for healthy status. If you want multiple return codes to represent healthy, sum up the corresponding values. Note: This field may return `null`, indicating that no valid values can be obtained.

Returns:

HttpCode Health check status code (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Value range: 1-31. Default value: 31. `1`: Returns code 1xx for healthy status. `2`: Returns code 2xx for healthy status. `4`: Returns code 3xx for healthy status. `8`: Returns code 4xx for healthy status. `16`: Returns code 5xx for healthy status. If you want multiple return codes to represent healthy, sum up the corresponding values. Note: This field may return `null`, indicating that no valid values can be obtained.

setHttpCode

public void setHttpCode(Long HttpCode)

Set Health check status code (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Value range: 1-31. Default value: 31. `1`: Returns code 1xx for healthy status. `2`: Returns code 2xx for healthy status. `4`: Returns code 3xx for healthy status. `8`: Returns code 4xx for healthy status. `16`: Returns code 5xx for healthy status. If you want multiple return codes to represent healthy, sum up the corresponding values. Note: This field may return `null`, indicating that no valid values can be obtained.

Parameters:

HttpCode - Health check status code (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Value range: 1-31. Default value: 31. `1`: Returns code 1xx for healthy status. `2`: Returns code 2xx for healthy status. `4`: Returns code 3xx for healthy status. `8`: Returns code 4xx for healthy status. `16`: Returns code 5xx for healthy status. If you want multiple return codes to represent healthy, sum up the corresponding values. Note: This field may return `null`, indicating that no valid values can be obtained.

getHttpCheckPath

public String getHttpCheckPath()

Get Health check path (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Note: This field may return null, indicating that no valid values can be obtained.

Returns:

HttpCheckPath Health check path (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Note: This field may return null, indicating that no valid values can be obtained.

setHttpCheckPath

public void setHttpCheckPath(String HttpCheckPath)

Set Health check path (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

HttpCheckPath - Health check path (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Note: This field may return null, indicating that no valid values can be obtained.

getHttpCheckDomain

public String getHttpCheckDomain()

Get The target domain name for health check. It’s applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners. It’s required for TCP listeners. Note: This field may return `null`, indicating that no valid values can be obtained.

Returns:

HttpCheckDomain The target domain name for health check. It’s applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners. It’s required for TCP listeners. Note: This field may return `null`, indicating that no valid values can be obtained.

setHttpCheckDomain

public void setHttpCheckDomain(String HttpCheckDomain)

Set The target domain name for health check. It’s applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners. It’s required for TCP listeners. Note: This field may return `null`, indicating that no valid values can be obtained.

Parameters:

HttpCheckDomain - The target domain name for health check. It’s applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners. It’s required for TCP listeners. Note: This field may return `null`, indicating that no valid values can be obtained.

getHttpCheckMethod

public String getHttpCheckMethod()

Get Health check method (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Value range: HEAD, GET. Default value: HEAD. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

HttpCheckMethod Health check method (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Value range: HEAD, GET. Default value: HEAD. Note: This field may return null, indicating that no valid values can be obtained.

setHttpCheckMethod

public void setHttpCheckMethod(String HttpCheckMethod)

Set Health check method (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Value range: HEAD, GET. Default value: HEAD. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

HttpCheckMethod - Health check method (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Value range: HEAD, GET. Default value: HEAD. 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, it is recommended to leave it empty. (Applicable only to TCP/UDP listeners.) 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, it is recommended to leave it empty. (Applicable only to TCP/UDP listeners.) 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, it is recommended to leave it empty. (Applicable only to TCP/UDP listeners.) 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, it is recommended to leave it empty. (Applicable only to TCP/UDP listeners.) 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. Value range: 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. (Applicable only to TCP/UDP listeners.) 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. Value range: 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. (Applicable only to TCP/UDP listeners.) 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. Value range: 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. (Applicable only to TCP/UDP listeners.) 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. Value range: 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. (Applicable only to TCP/UDP listeners.) 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. Only ASCII visible characters are allowed, and the maximum length is 500. (Applicable only to TCP/UDP listeners.) 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. Only ASCII visible characters are allowed, and the maximum length is 500. (Applicable only to TCP/UDP listeners.) 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. Only ASCII visible characters are allowed, and the maximum length is 500. (Applicable only to TCP/UDP listeners.) 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. Only ASCII visible characters are allowed, and the maximum length is 500. (Applicable only to TCP/UDP listeners.) 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. Only ASCII visible characters are allowed, and the maximum length is 500. (Applicable only to TCP/UDP listeners.) 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. Only ASCII visible characters are allowed, and the maximum length is 500. (Applicable only to TCP/UDP listeners.) 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. Only ASCII visible characters are allowed, and the maximum length is 500. (Applicable only to TCP/UDP listeners.) 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. Only ASCII visible characters are allowed, and the maximum length is 500. (Applicable only to TCP/UDP listeners.) 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). Value range: TCP, HTTP, CUSTOM (applicable only to TCP/UDP listeners, where UDP listeners only support CUSTOM. If custom health check is used, this parameter is required). Note: This field may return null, indicating that no valid values can be obtained.

Returns:

CheckType Health check protocol (a custom check parameter). Value range: TCP, HTTP, CUSTOM (applicable only to TCP/UDP listeners, where UDP listeners only support CUSTOM. If custom health check is used, this parameter is 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). Value range: TCP, HTTP, CUSTOM (applicable only to TCP/UDP listeners, where UDP listeners only support CUSTOM. If custom health check is used, this parameter is required). Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

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

getHttpVersion

public String getHttpVersion()

Get Health check protocol (a custom check parameter), which is required if the value of CheckType is HTTP. This parameter represents the HTTP version of the real server. Value range: HTTP/1.0, HTTP/1.1. (Applicable only to TCP listeners.) Note: This field may return null, indicating that no valid values can be obtained.

Returns:

HttpVersion Health check protocol (a custom check parameter), which is required if the value of CheckType is HTTP. This parameter represents the HTTP version of the real server. Value range: HTTP/1.0, HTTP/1.1. (Applicable only to TCP listeners.) Note: This field may return null, indicating that no valid values can be obtained.

setHttpVersion

public void setHttpVersion(String HttpVersion)

Set Health check protocol (a custom check parameter), which is required if the value of CheckType is HTTP. This parameter represents the HTTP version of the real server. Value range: HTTP/1.0, HTTP/1.1. (Applicable only to TCP listeners.) Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

HttpVersion - Health check protocol (a custom check parameter), which is required if the value of CheckType is HTTP. This parameter represents the HTTP version of the real server. Value range: HTTP/1.0, HTTP/1.1. (Applicable only to TCP listeners.) Note: This field may return null, indicating that no valid values can be obtained.

getSourceIpType

public Long getSourceIpType()

Get Specifies the type of IP for health check. `0` (default): CLB VIP. `1`: Use the IP range starting with 100.64 as the source IP. Note: This field may return `null`, indicating that no valid values can be obtained.

Returns:

SourceIpType Specifies the type of IP for health check. `0` (default): CLB VIP. `1`: Use the IP range starting with 100.64 as the source IP. Note: This field may return `null`, indicating that no valid values can be obtained.

setSourceIpType

public void setSourceIpType(Long SourceIpType)

Set Specifies the type of IP for health check. `0` (default): CLB VIP. `1`: Use the IP range starting with 100.64 as the source IP. Note: This field may return `null`, indicating that no valid values can be obtained.

Parameters:

SourceIpType - Specifies the type of IP for health check. `0` (default): CLB VIP. `1`: Use the IP range starting with 100.64 as the source IP. Note: This field may return `null`, indicating that no valid values can be obtained.

getExtendedCode

public String getExtendedCode()

Get GRPC health check status code, which is only applicable to rules with GRPC as the backend forwarding protocol. It can be a single number (such as `20`), multiple numbers (such as `20,25`) or a range (such as `0-99`). The default value is `12`. Note: This field may return `null`, indicating that no valid values can be obtained.

Returns:

ExtendedCode GRPC health check status code, which is only applicable to rules with GRPC as the backend forwarding protocol. It can be a single number (such as `20`), multiple numbers (such as `20,25`) or a range (such as `0-99`). The default value is `12`. Note: This field may return `null`, indicating that no valid values can be obtained.

setExtendedCode

public void setExtendedCode(String ExtendedCode)

Set GRPC health check status code, which is only applicable to rules with GRPC as the backend forwarding protocol. It can be a single number (such as `20`), multiple numbers (such as `20,25`) or a range (such as `0-99`). The default value is `12`. Note: This field may return `null`, indicating that no valid values can be obtained.

Parameters:

ExtendedCode - GRPC health check status code, which is only applicable to rules with GRPC as the backend forwarding protocol. It can be a single number (such as `20`), multiple numbers (such as `20,25`) or a range (such as `0-99`). The default value is `12`. 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