TargetGroupHealthCheck (tencentcloud-sdk-java 3.1.1355 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.clb.v20180317.models.TargetGroupHealthCheck

public class TargetGroupHealthCheck
extends AbstractModel

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

Constructor Summary

Constructors
Constructor and Description
`TargetGroupHealthCheck()`
`TargetGroupHealthCheck(TargetGroupHealthCheck 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`	`getBadLimit()` Get 检测不健康阈值。默认为3秒。可配置范围：2 - 10次。
`String`	`getContextType()` Get 健康检查的输入格式，健康检查方式取CUSTOM时，必填此字段，可取值：HEX或TEXT，其中：TEXT：文本格式。HEX：十六进制格式， SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。仅适用于TCP/UDP目标组。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getExtendedCode()` Get GRPC健康检查状态码（仅适用于后端转发协议为GRPC的目标组）。默认值为 12，可输入值为数值、多个数值、或者范围，例如 20 或 20,25 或 0-99。注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getGapTime()` Get 检测间隔时间。默认为5秒。可配置范围：2 - 300秒。
`Long`	`getGoodLimit()` Get 检测健康阈值。默认为3秒。可配置范围：2 - 10次。
`Boolean`	`getHealthSwitch()` Get 是否开启健康检查。
`String`	`getHttpCheckDomain()` Get 健康检查域名，其中：仅适用于HTTP/HTTPS目标组和TCP目标组的HTTP健康检查方式。针对HTTP/HTTPS目标组，当使用HTTP健康检查方式时，该参数为必填项。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getHttpCheckMethod()` Get 健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getHttpCheckPath()` Get 健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getHttpCode()` Get 健康检查状态码（仅适用于HTTP/HTTPS目标组、TCP目标组的HTTP健康检查方式）。可选值：1~31，默认 31，其中： 1 表示探测后返回值 1xx 代表健康。2 表示返回 2xx 代表健康。4 表示返回 3xx 代表健康。8 表示返回 4xx 代表健康。16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康，则将相应的值相加。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getHttpVersion()` Get HTTP版本, 其中：健康检查协议CheckType的值取HTTP时，必传此字段。支持配置选项：HTTP/1.0, HTTP/1.1。仅适用于TCP目标组。注意：此字段可能返回 null，表示取不到有效值。
`Boolean`	`getJumboFrame()` Get 目标组下的所有rs的探测包是否开启巨帧。默认开启。仅GWLB类型目标组支持该参数。
`Long`	`getPort()` Get 自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。（仅适用于TCP/UDP目标组）。
`String`	`getProtocol()` Get 健康检查方式，其中仅V2新版目标组类型支持该参数，支持取值 TCP \| HTTP \| HTTPS \| PING \| CUSTOM，其中: 当目标组后端转发协议为TCP时，健康检查方式支持 TCP/HTTP/CUSTOM，默认为TCP。当目标组后端转发协议为UDP时，健康检查方式支持 PING/CUSTOM，默认为PING。当目标组后端转发协议为HTTP时，健康检查方式支持 HTTP/TCP，默认为HTTP。当目标组后端转发协议为HTTPS时，健康检查方式支持 HTTPS/TCP，默认为HTTPS。当目标组后端转发协议为GRPC时，健康检查方式支持GRPC/TCP，默认为GRPC。
`String`	`getRecvContext()` Get 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP目标组）。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getSendContext()` Get 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP目标组）。注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getTimeout()` Get 健康检查超时时间。默认为2秒。可配置范围：2 - 30秒。
`void`	`setBadLimit(Long BadLimit)` Set 检测不健康阈值。默认为3秒。可配置范围：2 - 10次。
`void`	`setContextType(String ContextType)` Set 健康检查的输入格式，健康检查方式取CUSTOM时，必填此字段，可取值：HEX或TEXT，其中：TEXT：文本格式。HEX：十六进制格式， SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。仅适用于TCP/UDP目标组。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setExtendedCode(String ExtendedCode)` Set GRPC健康检查状态码（仅适用于后端转发协议为GRPC的目标组）。默认值为 12，可输入值为数值、多个数值、或者范围，例如 20 或 20,25 或 0-99。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setGapTime(Long GapTime)` Set 检测间隔时间。默认为5秒。可配置范围：2 - 300秒。
`void`	`setGoodLimit(Long GoodLimit)` Set 检测健康阈值。默认为3秒。可配置范围：2 - 10次。
`void`	`setHealthSwitch(Boolean HealthSwitch)` Set 是否开启健康检查。
`void`	`setHttpCheckDomain(String HttpCheckDomain)` Set 健康检查域名，其中：仅适用于HTTP/HTTPS目标组和TCP目标组的HTTP健康检查方式。针对HTTP/HTTPS目标组，当使用HTTP健康检查方式时，该参数为必填项。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setHttpCheckMethod(String HttpCheckMethod)` Set 健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setHttpCheckPath(String HttpCheckPath)` Set 健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setHttpCode(Long HttpCode)` Set 健康检查状态码（仅适用于HTTP/HTTPS目标组、TCP目标组的HTTP健康检查方式）。可选值：1~31，默认 31，其中： 1 表示探测后返回值 1xx 代表健康。2 表示返回 2xx 代表健康。4 表示返回 3xx 代表健康。8 表示返回 4xx 代表健康。16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康，则将相应的值相加。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setHttpVersion(String HttpVersion)` Set HTTP版本, 其中：健康检查协议CheckType的值取HTTP时，必传此字段。支持配置选项：HTTP/1.0, HTTP/1.1。仅适用于TCP目标组。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setJumboFrame(Boolean JumboFrame)` Set 目标组下的所有rs的探测包是否开启巨帧。默认开启。仅GWLB类型目标组支持该参数。
`void`	`setPort(Long Port)` Set 自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。（仅适用于TCP/UDP目标组）。
`void`	`setProtocol(String Protocol)` Set 健康检查方式，其中仅V2新版目标组类型支持该参数，支持取值 TCP \| HTTP \| HTTPS \| PING \| CUSTOM，其中: 当目标组后端转发协议为TCP时，健康检查方式支持 TCP/HTTP/CUSTOM，默认为TCP。当目标组后端转发协议为UDP时，健康检查方式支持 PING/CUSTOM，默认为PING。当目标组后端转发协议为HTTP时，健康检查方式支持 HTTP/TCP，默认为HTTP。当目标组后端转发协议为HTTPS时，健康检查方式支持 HTTPS/TCP，默认为HTTPS。当目标组后端转发协议为GRPC时，健康检查方式支持GRPC/TCP，默认为GRPC。
`void`	`setRecvContext(String RecvContext)` Set 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP目标组）。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setSendContext(String SendContext)` Set 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP目标组）。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setTimeout(Long Timeout)` Set 健康检查超时时间。默认为2秒。可配置范围：2 - 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
  - TargetGroupHealthCheck
```
public TargetGroupHealthCheck()
```
  - TargetGroupHealthCheck
```
public TargetGroupHealthCheck(TargetGroupHealthCheck 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 Boolean getHealthSwitch()
```
    Get 是否开启健康检查。
    
    Returns:
    
    HealthSwitch 是否开启健康检查。
  - setHealthSwitch
```
public void setHealthSwitch(Boolean HealthSwitch)
```
    Set 是否开启健康检查。
    
    Parameters:
    
    HealthSwitch - 是否开启健康检查。
  - getProtocol
```
public String getProtocol()
```
    Get 健康检查方式，其中仅V2新版目标组类型支持该参数，支持取值 TCP | HTTP | HTTPS | PING | CUSTOM，其中:
  - 当目标组后端转发协议为TCP时，健康检查方式支持 TCP/HTTP/CUSTOM，默认为TCP。
  - 当目标组后端转发协议为UDP时，健康检查方式支持 PING/CUSTOM，默认为PING。
  - 当目标组后端转发协议为HTTP时，健康检查方式支持 HTTP/TCP，默认为HTTP。
  - 当目标组后端转发协议为HTTPS时，健康检查方式支持 HTTPS/TCP，默认为HTTPS。
  - 当目标组后端转发协议为GRPC时，健康检查方式支持GRPC/TCP，默认为GRPC。

Returns:: Protocol 健康检查方式，其中仅V2新版目标组类型支持该参数，支持取值 TCP | HTTP | HTTPS | PING | CUSTOM，其中:
当目标组后端转发协议为TCP时，健康检查方式支持 TCP/HTTP/CUSTOM，默认为TCP。
当目标组后端转发协议为UDP时，健康检查方式支持 PING/CUSTOM，默认为PING。
当目标组后端转发协议为HTTP时，健康检查方式支持 HTTP/TCP，默认为HTTP。
当目标组后端转发协议为HTTPS时，健康检查方式支持 HTTPS/TCP，默认为HTTPS。
当目标组后端转发协议为GRPC时，健康检查方式支持GRPC/TCP，默认为GRPC。

setProtocol
```
public void setProtocol(String Protocol)
```
Set 健康检查方式，其中仅V2新版目标组类型支持该参数，支持取值 TCP | HTTP | HTTPS | PING | CUSTOM，其中:
当目标组后端转发协议为TCP时，健康检查方式支持 TCP/HTTP/CUSTOM，默认为TCP。
当目标组后端转发协议为UDP时，健康检查方式支持 PING/CUSTOM，默认为PING。
当目标组后端转发协议为HTTP时，健康检查方式支持 HTTP/TCP，默认为HTTP。
当目标组后端转发协议为HTTPS时，健康检查方式支持 HTTPS/TCP，默认为HTTPS。
当目标组后端转发协议为GRPC时，健康检查方式支持GRPC/TCP，默认为GRPC。

Class TargetGroupHealthCheck

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

TargetGroupHealthCheck

TargetGroupHealthCheck

Method Detail

getHealthSwitch

setHealthSwitch

getProtocol

setProtocol

getPort

setPort

getTimeout

setTimeout

getGapTime

setGapTime

getGoodLimit

setGoodLimit

getBadLimit

setBadLimit

getJumboFrame

setJumboFrame

getHttpCode

setHttpCode

getHttpCheckDomain

setHttpCheckDomain

getHttpCheckPath

setHttpCheckPath

getHttpCheckMethod

setHttpCheckMethod

getContextType

setContextType

getSendContext

setSendContext

getRecvContext

setRecvContext

getHttpVersion

setHttpVersion

getExtendedCode

setExtendedCode

toMap