CreateListenerRequest (tencentcloud-sdk-java 3.1.425 API)

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

public class CreateListenerRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description
`CreateListenerRequest()`
`CreateListenerRequest(CreateListenerRequest 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
`CertificateInput`	`getCertificate()` Get 证书相关信息，此参数仅适用于TCP_SSL监听器和未开启SNI特性的HTTPS监听器。
`Boolean`	`getDeregisterTargetRst()` Get 解绑后端目标时，是否发RST给客户端，此参数仅适用于TCP监听器。
`Long`	`getEndPort()` Get 创建端口段监听器时必须传入此参数，用以标识结束端口。同时，入参Ports只允许传入一个成员，用以标识开始端口。【如果您需要体验端口段功能，请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】。
`HealthCheck`	`getHealthCheck()` Get 健康检查相关参数，此参数仅适用于TCP/UDP/TCP_SSL监听器。
`Long`	`getKeepaliveEnable()` Get 是否开启长连接，此参数仅适用于HTTP/HTTPS监听器，0:关闭；1:开启，默认关闭。
`String[]`	`getListenerNames()` Get 要创建的监听器名称列表，名称与Ports数组按序一一对应，如不需立即命名，则无需提供此参数。
`String`	`getLoadBalancerId()` Get 负载均衡实例 ID。
`Long[]`	`getPorts()` Get 要将监听器创建到哪些端口，每个端口对应一个新的监听器。
`String`	`getProtocol()` Get 监听器协议： TCP \| UDP \| HTTP \| HTTPS \| TCP_SSL（TCP_SSL 正在内测中，如需使用请通过工单申请）。
`String`	`getScheduler()` Get 监听器转发的方式。可选值：WRR、LEAST_CONN 分别表示按权重轮询、最小连接数，默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL监听器。
`Long`	`getSessionExpireTime()` Get 会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。此参数仅适用于TCP/UDP监听器。
`String`	`getSessionType()` Get 会话保持类型。不传或传NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。
`Long`	`getSniSwitch()` Get 是否开启SNI特性，此参数仅适用于HTTPS监听器。
`String`	`getTargetType()` Get 后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组。
`void`	`setCertificate(CertificateInput Certificate)` Set 证书相关信息，此参数仅适用于TCP_SSL监听器和未开启SNI特性的HTTPS监听器。
`void`	`setDeregisterTargetRst(Boolean DeregisterTargetRst)` Set 解绑后端目标时，是否发RST给客户端，此参数仅适用于TCP监听器。
`void`	`setEndPort(Long EndPort)` Set 创建端口段监听器时必须传入此参数，用以标识结束端口。同时，入参Ports只允许传入一个成员，用以标识开始端口。【如果您需要体验端口段功能，请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】。
`void`	`setHealthCheck(HealthCheck HealthCheck)` Set 健康检查相关参数，此参数仅适用于TCP/UDP/TCP_SSL监听器。
`void`	`setKeepaliveEnable(Long KeepaliveEnable)` Set 是否开启长连接，此参数仅适用于HTTP/HTTPS监听器，0:关闭；1:开启，默认关闭。
`void`	`setListenerNames(String[] ListenerNames)` Set 要创建的监听器名称列表，名称与Ports数组按序一一对应，如不需立即命名，则无需提供此参数。
`void`	`setLoadBalancerId(String LoadBalancerId)` Set 负载均衡实例 ID。
`void`	`setPorts(Long[] Ports)` Set 要将监听器创建到哪些端口，每个端口对应一个新的监听器。
`void`	`setProtocol(String Protocol)` Set 监听器协议： TCP \| UDP \| HTTP \| HTTPS \| TCP_SSL（TCP_SSL 正在内测中，如需使用请通过工单申请）。
`void`	`setScheduler(String Scheduler)` Set 监听器转发的方式。可选值：WRR、LEAST_CONN 分别表示按权重轮询、最小连接数，默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL监听器。
`void`	`setSessionExpireTime(Long SessionExpireTime)` Set 会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。此参数仅适用于TCP/UDP监听器。
`void`	`setSessionType(String SessionType)` Set 会话保持类型。不传或传NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。
`void`	`setSniSwitch(Long SniSwitch)` Set 是否开启SNI特性，此参数仅适用于HTTPS监听器。
`void`	`setTargetType(String TargetType)` Set 后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组。
`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
  - CreateListenerRequest
```
public CreateListenerRequest()
```
  - CreateListenerRequest
```
public CreateListenerRequest(CreateListenerRequest 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
  - getLoadBalancerId
```
public String getLoadBalancerId()
```
    Get 负载均衡实例 ID。
    
    Returns:
    
    LoadBalancerId 负载均衡实例 ID。
  - setLoadBalancerId
```
public void setLoadBalancerId(String LoadBalancerId)
```
    Set 负载均衡实例 ID。
    
    Parameters:
    
    LoadBalancerId - 负载均衡实例 ID。
  - getPorts
```
public Long[] getPorts()
```
    Get 要将监听器创建到哪些端口，每个端口对应一个新的监听器。
    
    Returns:
    
    Ports 要将监听器创建到哪些端口，每个端口对应一个新的监听器。
  - setPorts
```
public void setPorts(Long[] Ports)
```
    Set 要将监听器创建到哪些端口，每个端口对应一个新的监听器。
    
    Parameters:
    
    Ports - 要将监听器创建到哪些端口，每个端口对应一个新的监听器。
  - getProtocol
```
public String getProtocol()
```
    Get 监听器协议： TCP | UDP | HTTP | HTTPS | TCP_SSL（TCP_SSL 正在内测中，如需使用请通过工单申请）。
    
    Returns:
    
    Protocol 监听器协议： TCP | UDP | HTTP | HTTPS | TCP_SSL（TCP_SSL 正在内测中，如需使用请通过工单申请）。
  - setProtocol
```
public void setProtocol(String Protocol)
```
    Set 监听器协议： TCP | UDP | HTTP | HTTPS | TCP_SSL（TCP_SSL 正在内测中，如需使用请通过工单申请）。
    
    Parameters:
    
    Protocol - 监听器协议： TCP | UDP | HTTP | HTTPS | TCP_SSL（TCP_SSL 正在内测中，如需使用请通过工单申请）。
  - getListenerNames
```
public String[] getListenerNames()
```
    Get 要创建的监听器名称列表，名称与Ports数组按序一一对应，如不需立即命名，则无需提供此参数。
    
    Returns:
    
    ListenerNames 要创建的监听器名称列表，名称与Ports数组按序一一对应，如不需立即命名，则无需提供此参数。
  - setListenerNames
```
public void setListenerNames(String[] ListenerNames)
```
    Set 要创建的监听器名称列表，名称与Ports数组按序一一对应，如不需立即命名，则无需提供此参数。
    
    Parameters:
    
    ListenerNames - 要创建的监听器名称列表，名称与Ports数组按序一一对应，如不需立即命名，则无需提供此参数。
  - getHealthCheck
```
public HealthCheck getHealthCheck()
```
    Get 健康检查相关参数，此参数仅适用于TCP/UDP/TCP_SSL监听器。
    
    Returns:
    
    HealthCheck 健康检查相关参数，此参数仅适用于TCP/UDP/TCP_SSL监听器。
  - setHealthCheck
```
public void setHealthCheck(HealthCheck HealthCheck)
```
    Set 健康检查相关参数，此参数仅适用于TCP/UDP/TCP_SSL监听器。
    
    Parameters:
    
    HealthCheck - 健康检查相关参数，此参数仅适用于TCP/UDP/TCP_SSL监听器。
  - getCertificate
```
public CertificateInput getCertificate()
```
    Get 证书相关信息，此参数仅适用于TCP_SSL监听器和未开启SNI特性的HTTPS监听器。
    
    Returns:
    
    Certificate 证书相关信息，此参数仅适用于TCP_SSL监听器和未开启SNI特性的HTTPS监听器。
  - setCertificate
```
public void setCertificate(CertificateInput Certificate)
```
    Set 证书相关信息，此参数仅适用于TCP_SSL监听器和未开启SNI特性的HTTPS监听器。
    
    Parameters:
    
    Certificate - 证书相关信息，此参数仅适用于TCP_SSL监听器和未开启SNI特性的HTTPS监听器。
  - getSessionExpireTime
```
public Long getSessionExpireTime()
```
    Get 会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。此参数仅适用于TCP/UDP监听器。
    
    Returns:
    
    SessionExpireTime 会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。此参数仅适用于TCP/UDP监听器。
  - setSessionExpireTime
```
public void setSessionExpireTime(Long SessionExpireTime)
```
    Set 会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。此参数仅适用于TCP/UDP监听器。
    
    Parameters:
    
    SessionExpireTime - 会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。此参数仅适用于TCP/UDP监听器。
  - getScheduler
```
public String getScheduler()
```
    Get 监听器转发的方式。可选值：WRR、LEAST_CONN 分别表示按权重轮询、最小连接数，默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL监听器。
    
    Returns:
    
    Scheduler 监听器转发的方式。可选值：WRR、LEAST_CONN 分别表示按权重轮询、最小连接数，默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL监听器。
  - setScheduler
```
public void setScheduler(String Scheduler)
```
    Set 监听器转发的方式。可选值：WRR、LEAST_CONN 分别表示按权重轮询、最小连接数，默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL监听器。
    
    Parameters:
    
    Scheduler - 监听器转发的方式。可选值：WRR、LEAST_CONN 分别表示按权重轮询、最小连接数，默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL监听器。
  - getSniSwitch
```
public Long getSniSwitch()
```
    Get 是否开启SNI特性，此参数仅适用于HTTPS监听器。
    
    Returns:
    
    SniSwitch 是否开启SNI特性，此参数仅适用于HTTPS监听器。
  - setSniSwitch
```
public void setSniSwitch(Long SniSwitch)
```
    Set 是否开启SNI特性，此参数仅适用于HTTPS监听器。
    
    Parameters:
    
    SniSwitch - 是否开启SNI特性，此参数仅适用于HTTPS监听器。
  - getTargetType
```
public String getTargetType()
```
    Get 后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组。
    
    Returns:
    
    TargetType 后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组。
  - setTargetType
```
public void setTargetType(String TargetType)
```
    Set 后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组。
    
    Parameters:
    
    TargetType - 后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组。
  - getSessionType
```
public String getSessionType()
```
    Get 会话保持类型。不传或传NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。
    
    Returns:
    
    SessionType 会话保持类型。不传或传NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。
  - setSessionType
```
public void setSessionType(String SessionType)
```
    Set 会话保持类型。不传或传NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。
    
    Parameters:
    
    SessionType - 会话保持类型。不传或传NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。
  - getKeepaliveEnable
```
public Long getKeepaliveEnable()
```
    Get 是否开启长连接，此参数仅适用于HTTP/HTTPS监听器，0:关闭；1:开启，默认关闭。
    
    Returns:
    
    KeepaliveEnable 是否开启长连接，此参数仅适用于HTTP/HTTPS监听器，0:关闭；1:开启，默认关闭。
  - setKeepaliveEnable
```
public void setKeepaliveEnable(Long KeepaliveEnable)
```
    Set 是否开启长连接，此参数仅适用于HTTP/HTTPS监听器，0:关闭；1:开启，默认关闭。
    
    Parameters:
    
    KeepaliveEnable - 是否开启长连接，此参数仅适用于HTTP/HTTPS监听器，0:关闭；1:开启，默认关闭。
  - getEndPort
```
public Long getEndPort()
```
    Get 创建端口段监听器时必须传入此参数，用以标识结束端口。同时，入参Ports只允许传入一个成员，用以标识开始端口。【如果您需要体验端口段功能，请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】。
    
    Returns:
    
    EndPort 创建端口段监听器时必须传入此参数，用以标识结束端口。同时，入参Ports只允许传入一个成员，用以标识开始端口。【如果您需要体验端口段功能，请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】。
  - setEndPort
```
public void setEndPort(Long EndPort)
```
    Set 创建端口段监听器时必须传入此参数，用以标识结束端口。同时，入参Ports只允许传入一个成员，用以标识开始端口。【如果您需要体验端口段功能，请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】。
    
    Parameters:
    
    EndPort - 创建端口段监听器时必须传入此参数，用以标识结束端口。同时，入参Ports只允许传入一个成员，用以标识开始端口。【如果您需要体验端口段功能，请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】。
  - getDeregisterTargetRst
```
public Boolean getDeregisterTargetRst()
```
    Get 解绑后端目标时，是否发RST给客户端，此参数仅适用于TCP监听器。
    
    Returns:
    
    DeregisterTargetRst 解绑后端目标时，是否发RST给客户端，此参数仅适用于TCP监听器。
  - setDeregisterTargetRst
```
public void setDeregisterTargetRst(Boolean DeregisterTargetRst)
```
    Set 解绑后端目标时，是否发RST给客户端，此参数仅适用于TCP监听器。
    
    Parameters:
    
    DeregisterTargetRst - 解绑后端目标时，是否发RST给客户端，此参数仅适用于TCP监听器。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class CreateListenerRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

CreateListenerRequest

CreateListenerRequest

Method Detail

getLoadBalancerId

setLoadBalancerId

getPorts

setPorts

getProtocol

setProtocol

getListenerNames

setListenerNames

getHealthCheck

setHealthCheck

getCertificate

setCertificate

getSessionExpireTime

setSessionExpireTime

getScheduler

setScheduler

getSniSwitch

setSniSwitch

getTargetType

setTargetType

getSessionType

setSessionType

getKeepaliveEnable

setKeepaliveEnable

getEndPort

setEndPort

getDeregisterTargetRst

setDeregisterTargetRst

toMap