HealthCheck (tencentcloud-sdk-java 3.1.1355 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.ecm.v20190719.models.HealthCheck

public class HealthCheck
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getCheckPort()` Get 自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getCheckType()` Get 自定义探测相关参数。健康检查使用的协议：TCP \| CUSTOM（UDP监听器只支持CUSTOM；如果使用自定义健康检查功能，则必传）。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getContextType()` Get 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getHealthNum()` Get 健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getHealthSwitch()` Get 是否开启健康检查：1（开启）、0（关闭）注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getIntervalTime()` Get 健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getRecvContext()` Get 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getSendContext()` Get 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getTimeOut()` Get 健康检查的响应超时时间，可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getUnHealthyNum()` Get 不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setCheckPort(Long CheckPort)` Set 自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setCheckType(String CheckType)` Set 自定义探测相关参数。健康检查使用的协议：TCP \| CUSTOM（UDP监听器只支持CUSTOM；如果使用自定义健康检查功能，则必传）。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setContextType(String ContextType)` Set 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setHealthNum(Long HealthNum)` Set 健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setHealthSwitch(Long HealthSwitch)` Set 是否开启健康检查：1（开启）、0（关闭）注意：此字段可能返回 null，表示取不到有效值。
`void`	`setIntervalTime(Long IntervalTime)` Set 健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setRecvContext(String RecvContext)` Set 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setSendContext(String SendContext)` Set 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setTimeOut(Long TimeOut)` Set 健康检查的响应超时时间，可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setUnHealthyNum(Long UnHealthyNum)` Set 不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
`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
  - 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 是否开启健康检查：1（开启）、0（关闭）注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    HealthSwitch 是否开启健康检查：1（开启）、0（关闭）注意：此字段可能返回 null，表示取不到有效值。
  - setHealthSwitch
```
public void setHealthSwitch(Long HealthSwitch)
```
    Set 是否开启健康检查：1（开启）、0（关闭）注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    HealthSwitch - 是否开启健康检查：1（开启）、0（关闭）注意：此字段可能返回 null，表示取不到有效值。
  - getTimeOut
```
public Long getTimeOut()
```
    Get 健康检查的响应超时时间，可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    TimeOut 健康检查的响应超时时间，可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。注意：此字段可能返回 null，表示取不到有效值。
  - setTimeOut
```
public void setTimeOut(Long TimeOut)
```
    Set 健康检查的响应超时时间，可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    TimeOut - 健康检查的响应超时时间，可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。注意：此字段可能返回 null，表示取不到有效值。
  - getIntervalTime
```
public Long getIntervalTime()
```
    Get 健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    IntervalTime 健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。注意：此字段可能返回 null，表示取不到有效值。
  - setIntervalTime
```
public void setIntervalTime(Long IntervalTime)
```
    Set 健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    IntervalTime - 健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。注意：此字段可能返回 null，表示取不到有效值。
  - getHealthNum
```
public Long getHealthNum()
```
    Get 健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    HealthNum 健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
  - setHealthNum
```
public void setHealthNum(Long HealthNum)
```
    Set 健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    HealthNum - 健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
  - getUnHealthyNum
```
public Long getUnHealthyNum()
```
    Get 不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    UnHealthyNum 不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
  - setUnHealthyNum
```
public void setUnHealthyNum(Long UnHealthyNum)
```
    Set 不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    UnHealthyNum - 不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
  - getCheckPort
```
public Long getCheckPort()
```
    Get 自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    CheckPort 自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。注意：此字段可能返回 null，表示取不到有效值。
  - setCheckPort
```
public void setCheckPort(Long CheckPort)
```
    Set 自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    CheckPort - 自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。注意：此字段可能返回 null，表示取不到有效值。
  - getContextType
```
public String getContextType()
```
    Get 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    ContextType 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。注意：此字段可能返回 null，表示取不到有效值。
  - setContextType
```
public void setContextType(String ContextType)
```
    Set 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    ContextType - 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。注意：此字段可能返回 null，表示取不到有效值。
  - getSendContext
```
public String getSendContext()
```
    Get 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    SendContext 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。注意：此字段可能返回 null，表示取不到有效值。
  - setSendContext
```
public void setSendContext(String SendContext)
```
    Set 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    SendContext - 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。注意：此字段可能返回 null，表示取不到有效值。
  - getRecvContext
```
public String getRecvContext()
```
    Get 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    RecvContext 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。注意：此字段可能返回 null，表示取不到有效值。
  - setRecvContext
```
public void setRecvContext(String RecvContext)
```
    Set 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    RecvContext - 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。注意：此字段可能返回 null，表示取不到有效值。
  - getCheckType
```
public String getCheckType()
```
    Get 自定义探测相关参数。健康检查使用的协议：TCP | CUSTOM（UDP监听器只支持CUSTOM；如果使用自定义健康检查功能，则必传）。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    CheckType 自定义探测相关参数。健康检查使用的协议：TCP | CUSTOM（UDP监听器只支持CUSTOM；如果使用自定义健康检查功能，则必传）。注意：此字段可能返回 null，表示取不到有效值。
  - setCheckType
```
public void setCheckType(String CheckType)
```
    Set 自定义探测相关参数。健康检查使用的协议：TCP | CUSTOM（UDP监听器只支持CUSTOM；如果使用自定义健康检查功能，则必传）。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    CheckType - 自定义探测相关参数。健康检查使用的协议：TCP | CUSTOM（UDP监听器只支持CUSTOM；如果使用自定义健康检查功能，则必传）。注意：此字段可能返回 null，表示取不到有效值。
  - 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.

Class HealthCheck

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

HealthCheck

HealthCheck

Method Detail

getHealthSwitch

setHealthSwitch

getTimeOut

setTimeOut

getIntervalTime

setIntervalTime

getHealthNum

setHealthNum

getUnHealthyNum

setUnHealthyNum

getCheckPort

setCheckPort

getContextType

setContextType

getSendContext

setSendContext

getRecvContext

setRecvContext

getCheckType

setCheckType

toMap