com.tencentcloudapi.apigateway.v20180808.models

Class UpstreamHealthChecker

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.apigateway.v20180808.models.UpstreamHealthChecker

public class UpstreamHealthChecker
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
UpstreamHealthChecker()
UpstreamHealthChecker(UpstreamHealthChecker 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
String	getActiveCheckHttpPath() Get 主动健康检查时探测请求的路径。默认为"/"。
Long	getActiveCheckInterval() Get 主动健康检查的时间间隔，默认5秒。
Long	getActiveCheckTimeout() Get 主动健康检查的探测请求超时，单位秒。默认为5秒。
UpstreamHealthCheckerReqHeaders[]	getActiveRequestHeader() Get 主动健康检查时探测请求的的请求头。
Boolean	getEnableActiveCheck() Get 标识是否开启主动健康检查。
Boolean	getEnablePassiveCheck() Get 标识是否开启被动健康检查。
String	getHealthyHttpStatus() Get 健康检查时，判断为成功请求的 HTTP 状态码。
Long	getHttpFailureThreshold() Get HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围：[0, 254]。
Long	getTcpFailureThreshold() Get TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围：[0, 254]。
Long	getTimeoutThreshold() Get 连续超时阈值。0 表示禁用超时检查。取值范围：[0, 254]。
String	getUnhealthyHttpStatus() Get 健康检查时，判断为失败请求的 HTTP 状态码。
Long	getUnhealthyTimeout() Get 异常节点的状态自动恢复时间，单位秒。当只开启被动检查的话，必须设置为 > 0 的值，否则被动异常节点将无法恢复。默认30秒。
void	setActiveCheckHttpPath(String ActiveCheckHttpPath) Set 主动健康检查时探测请求的路径。默认为"/"。
void	setActiveCheckInterval(Long ActiveCheckInterval) Set 主动健康检查的时间间隔，默认5秒。
void	setActiveCheckTimeout(Long ActiveCheckTimeout) Set 主动健康检查的探测请求超时，单位秒。默认为5秒。
void	setActiveRequestHeader(UpstreamHealthCheckerReqHeaders[] ActiveRequestHeader) Set 主动健康检查时探测请求的的请求头。
void	setEnableActiveCheck(Boolean EnableActiveCheck) Set 标识是否开启主动健康检查。
void	setEnablePassiveCheck(Boolean EnablePassiveCheck) Set 标识是否开启被动健康检查。
void	setHealthyHttpStatus(String HealthyHttpStatus) Set 健康检查时，判断为成功请求的 HTTP 状态码。
void	setHttpFailureThreshold(Long HttpFailureThreshold) Set HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围：[0, 254]。
void	setTcpFailureThreshold(Long TcpFailureThreshold) Set TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围：[0, 254]。
void	setTimeoutThreshold(Long TimeoutThreshold) Set 连续超时阈值。0 表示禁用超时检查。取值范围：[0, 254]。
void	setUnhealthyHttpStatus(String UnhealthyHttpStatus) Set 健康检查时，判断为失败请求的 HTTP 状态码。
void	setUnhealthyTimeout(Long UnhealthyTimeout) Set 异常节点的状态自动恢复时间，单位秒。当只开启被动检查的话，必须设置为 > 0 的值，否则被动异常节点将无法恢复。默认30秒。
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, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

UpstreamHealthChecker

public UpstreamHealthChecker()

UpstreamHealthChecker

public UpstreamHealthChecker(UpstreamHealthChecker 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

getEnableActiveCheck

public Boolean getEnableActiveCheck()

Get 标识是否开启主动健康检查。

Returns:

EnableActiveCheck 标识是否开启主动健康检查。

setEnableActiveCheck

public void setEnableActiveCheck(Boolean EnableActiveCheck)

Set 标识是否开启主动健康检查。

Parameters:

EnableActiveCheck - 标识是否开启主动健康检查。

getEnablePassiveCheck

public Boolean getEnablePassiveCheck()

Get 标识是否开启被动健康检查。

Returns:

EnablePassiveCheck 标识是否开启被动健康检查。

setEnablePassiveCheck

public void setEnablePassiveCheck(Boolean EnablePassiveCheck)

Set 标识是否开启被动健康检查。

Parameters:

EnablePassiveCheck - 标识是否开启被动健康检查。

getHealthyHttpStatus

public String getHealthyHttpStatus()

Get 健康检查时，判断为成功请求的 HTTP 状态码。

Returns:

HealthyHttpStatus 健康检查时，判断为成功请求的 HTTP 状态码。

setHealthyHttpStatus

public void setHealthyHttpStatus(String HealthyHttpStatus)

Set 健康检查时，判断为成功请求的 HTTP 状态码。

Parameters:

HealthyHttpStatus - 健康检查时，判断为成功请求的 HTTP 状态码。

getUnhealthyHttpStatus

public String getUnhealthyHttpStatus()

Get 健康检查时，判断为失败请求的 HTTP 状态码。

Returns:

UnhealthyHttpStatus 健康检查时，判断为失败请求的 HTTP 状态码。

setUnhealthyHttpStatus

public void setUnhealthyHttpStatus(String UnhealthyHttpStatus)

Set 健康检查时，判断为失败请求的 HTTP 状态码。

Parameters:

UnhealthyHttpStatus - 健康检查时，判断为失败请求的 HTTP 状态码。

getTcpFailureThreshold

public Long getTcpFailureThreshold()

Get TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围：[0, 254]。

Returns:

TcpFailureThreshold TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围：[0, 254]。

setTcpFailureThreshold

public void setTcpFailureThreshold(Long TcpFailureThreshold)

Set TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围：[0, 254]。

Parameters:

TcpFailureThreshold - TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围：[0, 254]。

getTimeoutThreshold

public Long getTimeoutThreshold()

Get 连续超时阈值。0 表示禁用超时检查。取值范围：[0, 254]。

Returns:

TimeoutThreshold 连续超时阈值。0 表示禁用超时检查。取值范围：[0, 254]。

setTimeoutThreshold

public void setTimeoutThreshold(Long TimeoutThreshold)

Set 连续超时阈值。0 表示禁用超时检查。取值范围：[0, 254]。

Parameters:

TimeoutThreshold - 连续超时阈值。0 表示禁用超时检查。取值范围：[0, 254]。

getHttpFailureThreshold

public Long getHttpFailureThreshold()

Get HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围：[0, 254]。

Returns:

HttpFailureThreshold HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围：[0, 254]。

setHttpFailureThreshold

public void setHttpFailureThreshold(Long HttpFailureThreshold)

Set HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围：[0, 254]。

Parameters:

HttpFailureThreshold - HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围：[0, 254]。

getActiveCheckHttpPath

public String getActiveCheckHttpPath()

Get 主动健康检查时探测请求的路径。默认为"/"。

Returns:

ActiveCheckHttpPath 主动健康检查时探测请求的路径。默认为"/"。

setActiveCheckHttpPath

public void setActiveCheckHttpPath(String ActiveCheckHttpPath)

Set 主动健康检查时探测请求的路径。默认为"/"。

Parameters:

ActiveCheckHttpPath - 主动健康检查时探测请求的路径。默认为"/"。

getActiveCheckTimeout

public Long getActiveCheckTimeout()

Get 主动健康检查的探测请求超时，单位秒。默认为5秒。

Returns:

ActiveCheckTimeout 主动健康检查的探测请求超时，单位秒。默认为5秒。

setActiveCheckTimeout

public void setActiveCheckTimeout(Long ActiveCheckTimeout)

Set 主动健康检查的探测请求超时，单位秒。默认为5秒。

Parameters:

ActiveCheckTimeout - 主动健康检查的探测请求超时，单位秒。默认为5秒。

getActiveCheckInterval

public Long getActiveCheckInterval()

Get 主动健康检查的时间间隔，默认5秒。

Returns:

ActiveCheckInterval 主动健康检查的时间间隔，默认5秒。

setActiveCheckInterval

public void setActiveCheckInterval(Long ActiveCheckInterval)

Set 主动健康检查的时间间隔，默认5秒。

Parameters:

ActiveCheckInterval - 主动健康检查的时间间隔，默认5秒。

getActiveRequestHeader

public UpstreamHealthCheckerReqHeaders[] getActiveRequestHeader()

Get 主动健康检查时探测请求的的请求头。

Returns:

ActiveRequestHeader 主动健康检查时探测请求的的请求头。

setActiveRequestHeader

public void setActiveRequestHeader(UpstreamHealthCheckerReqHeaders[] ActiveRequestHeader)

Set 主动健康检查时探测请求的的请求头。

Parameters:

ActiveRequestHeader - 主动健康检查时探测请求的的请求头。

getUnhealthyTimeout

public Long getUnhealthyTimeout()

Get 异常节点的状态自动恢复时间，单位秒。当只开启被动检查的话，必须设置为 > 0 的值，否则被动异常节点将无法恢复。默认30秒。

Returns:

UnhealthyTimeout 异常节点的状态自动恢复时间，单位秒。当只开启被动检查的话，必须设置为 > 0 的值，否则被动异常节点将无法恢复。默认30秒。

setUnhealthyTimeout

public void setUnhealthyTimeout(Long UnhealthyTimeout)

Set 异常节点的状态自动恢复时间，单位秒。当只开启被动检查的话，必须设置为 > 0 的值，否则被动异常节点将无法恢复。默认30秒。

Parameters:

UnhealthyTimeout - 异常节点的状态自动恢复时间，单位秒。当只开启被动检查的话，必须设置为 > 0 的值，否则被动异常节点将无法恢复。默认30秒。

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.