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

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 The path for active health check.
Long	getActiveCheckInterval() Get The interval for active health check in seconds.
Long	getActiveCheckTimeout() Get The timeout period for active health check in seconds.
UpstreamHealthCheckerReqHeaders[]	getActiveRequestHeader() Get Header of the active health check request
Boolean	getEnableActiveCheck() Get Specifies whether to enable active health check
Boolean	getEnablePassiveCheck() Get Specifies whether the enable passive health check
String	getHealthyHttpStatus() Get The HTTP status code that indicates that the upstream is healthy
Long	getHttpFailureThreshold() Get The threshold on consecutive HTTP errors.
Long	getTcpFailureThreshold() Get The threshold on consecutive TCP errors.
Long	getTimeoutThreshold() Get The threshold on consecutive timeouts.
String	getUnhealthyHttpStatus() Get The HTTP status code that indicates that the upstream is unhealthy
Long	getUnhealthyTimeout() Get The period for an abnormal to recover automatically in seconds.
void	setActiveCheckHttpPath(String ActiveCheckHttpPath) Set The path for active health check.
void	setActiveCheckInterval(Long ActiveCheckInterval) Set The interval for active health check in seconds.
void	setActiveCheckTimeout(Long ActiveCheckTimeout) Set The timeout period for active health check in seconds.
void	setActiveRequestHeader(UpstreamHealthCheckerReqHeaders[] ActiveRequestHeader) Set Header of the active health check request
void	setEnableActiveCheck(Boolean EnableActiveCheck) Set Specifies whether to enable active health check
void	setEnablePassiveCheck(Boolean EnablePassiveCheck) Set Specifies whether the enable passive health check
void	setHealthyHttpStatus(String HealthyHttpStatus) Set The HTTP status code that indicates that the upstream is healthy
void	setHttpFailureThreshold(Long HttpFailureThreshold) Set The threshold on consecutive HTTP errors.
void	setTcpFailureThreshold(Long TcpFailureThreshold) Set The threshold on consecutive TCP errors.
void	setTimeoutThreshold(Long TimeoutThreshold) Set The threshold on consecutive timeouts.
void	setUnhealthyHttpStatus(String UnhealthyHttpStatus) Set The HTTP status code that indicates that the upstream is unhealthy
void	setUnhealthyTimeout(Long UnhealthyTimeout) Set The period for an abnormal to recover automatically in seconds.
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

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 Specifies whether to enable active health check

Returns:

EnableActiveCheck Specifies whether to enable active health check

setEnableActiveCheck

public void setEnableActiveCheck(Boolean EnableActiveCheck)

Set Specifies whether to enable active health check

Parameters:

EnableActiveCheck - Specifies whether to enable active health check

getEnablePassiveCheck

public Boolean getEnablePassiveCheck()

Get Specifies whether the enable passive health check

Returns:

EnablePassiveCheck Specifies whether the enable passive health check

setEnablePassiveCheck

public void setEnablePassiveCheck(Boolean EnablePassiveCheck)

Set Specifies whether the enable passive health check

Parameters:

EnablePassiveCheck - Specifies whether the enable passive health check

getHealthyHttpStatus

public String getHealthyHttpStatus()

Get The HTTP status code that indicates that the upstream is healthy

Returns:

HealthyHttpStatus The HTTP status code that indicates that the upstream is healthy

setHealthyHttpStatus

public void setHealthyHttpStatus(String HealthyHttpStatus)

Set The HTTP status code that indicates that the upstream is healthy

Parameters:

HealthyHttpStatus - The HTTP status code that indicates that the upstream is healthy

getUnhealthyHttpStatus

public String getUnhealthyHttpStatus()

Get The HTTP status code that indicates that the upstream is unhealthy

Returns:

UnhealthyHttpStatus The HTTP status code that indicates that the upstream is unhealthy

setUnhealthyHttpStatus

public void setUnhealthyHttpStatus(String UnhealthyHttpStatus)

Set The HTTP status code that indicates that the upstream is unhealthy

Parameters:

UnhealthyHttpStatus - The HTTP status code that indicates that the upstream is unhealthy

getTcpFailureThreshold

public Long getTcpFailureThreshold()

Get The threshold on consecutive TCP errors. Range: [0, 254]. `0` indicates not to check TCP.

Returns:

TcpFailureThreshold The threshold on consecutive TCP errors. Range: [0, 254]. `0` indicates not to check TCP.

setTcpFailureThreshold

public void setTcpFailureThreshold(Long TcpFailureThreshold)

Set The threshold on consecutive TCP errors. Range: [0, 254]. `0` indicates not to check TCP.

Parameters:

TcpFailureThreshold - The threshold on consecutive TCP errors. Range: [0, 254]. `0` indicates not to check TCP.

getTimeoutThreshold

public Long getTimeoutThreshold()

Get The threshold on consecutive timeouts. Range: [0, 254]. `0` indicates not to check TCP.

Returns:

TimeoutThreshold The threshold on consecutive timeouts. Range: [0, 254]. `0` indicates not to check TCP.

setTimeoutThreshold

public void setTimeoutThreshold(Long TimeoutThreshold)

Set The threshold on consecutive timeouts. Range: [0, 254]. `0` indicates not to check TCP.

Parameters:

TimeoutThreshold - The threshold on consecutive timeouts. Range: [0, 254]. `0` indicates not to check TCP.

getHttpFailureThreshold

public Long getHttpFailureThreshold()

Get The threshold on consecutive HTTP errors. Range: [0, 254]. `0` indicates not to check HTTP.

Returns:

HttpFailureThreshold The threshold on consecutive HTTP errors. Range: [0, 254]. `0` indicates not to check HTTP.

setHttpFailureThreshold

public void setHttpFailureThreshold(Long HttpFailureThreshold)

Set The threshold on consecutive HTTP errors. Range: [0, 254]. `0` indicates not to check HTTP.

Parameters:

HttpFailureThreshold - The threshold on consecutive HTTP errors. Range: [0, 254]. `0` indicates not to check HTTP.

getActiveCheckHttpPath

public String getActiveCheckHttpPath()

Get The path for active health check. It defaults to `/`.

Returns:

ActiveCheckHttpPath The path for active health check. It defaults to `/`.

setActiveCheckHttpPath

public void setActiveCheckHttpPath(String ActiveCheckHttpPath)

Set The path for active health check. It defaults to `/`.

Parameters:

ActiveCheckHttpPath - The path for active health check. It defaults to `/`.

getActiveCheckTimeout

public Long getActiveCheckTimeout()

Get The timeout period for active health check in seconds. Default: `5`.

Returns:

ActiveCheckTimeout The timeout period for active health check in seconds. Default: `5`.

setActiveCheckTimeout

public void setActiveCheckTimeout(Long ActiveCheckTimeout)

Set The timeout period for active health check in seconds. Default: `5`.

Parameters:

ActiveCheckTimeout - The timeout period for active health check in seconds. Default: `5`.

getActiveCheckInterval

public Long getActiveCheckInterval()

Get The interval for active health check in seconds. Default: `5`.

Returns:

ActiveCheckInterval The interval for active health check in seconds. Default: `5`.

setActiveCheckInterval

public void setActiveCheckInterval(Long ActiveCheckInterval)

Set The interval for active health check in seconds. Default: `5`.

Parameters:

ActiveCheckInterval - The interval for active health check in seconds. Default: `5`.

getActiveRequestHeader

public UpstreamHealthCheckerReqHeaders[] getActiveRequestHeader()

Get Header of the active health check request

Returns:

ActiveRequestHeader Header of the active health check request

setActiveRequestHeader

public void setActiveRequestHeader(UpstreamHealthCheckerReqHeaders[] ActiveRequestHeader)

Set Header of the active health check request

Parameters:

ActiveRequestHeader - Header of the active health check request

getUnhealthyTimeout

public Long getUnhealthyTimeout()

Get The period for an abnormal to recover automatically in seconds. If only the passive health check is enabled, it must be greater than 0. Otherwise the abnormal nodes can not recovered automatically. The default value is 30 seconds.

Returns:

UnhealthyTimeout The period for an abnormal to recover automatically in seconds. If only the passive health check is enabled, it must be greater than 0. Otherwise the abnormal nodes can not recovered automatically. The default value is 30 seconds.

setUnhealthyTimeout

public void setUnhealthyTimeout(Long UnhealthyTimeout)

Set The period for an abnormal to recover automatically in seconds. If only the passive health check is enabled, it must be greater than 0. Otherwise the abnormal nodes can not recovered automatically. The default value is 30 seconds.

Parameters:

UnhealthyTimeout - The period for an abnormal to recover automatically in seconds. If only the passive health check is enabled, it must be greater than 0. Otherwise the abnormal nodes can not recovered automatically. The default value is 30 seconds.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel