CreateListenerRequest (nlb20220430 1.1.0 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.nlb20220430.models.CreateListenerRequest

public class CreateListenerRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类
限定符和类型类和说明

static class CreateListenerRequest.CreateListenerRequestTag

嵌套类
限定符和类型	类和说明
`static class`	`CreateListenerRequest.CreateListenerRequestTag`

字段概要

字段
限定符和类型	字段和说明
`Boolean`	`alpnEnabled` Specifies whether to enable Application-Layer Protocol Negotiation (ALPN).
`String`	`alpnPolicy` The ALPN policy.
`List<String>`	`caCertificateIds` The certificate authority (CA) certificates.
`Boolean`	`caEnabled` Specifies whether to enable mutual authentication.
`List<String>`	`certificateIds` The server certificates.
`String`	`clientToken` The client token that is used to ensure the idempotence of the request.
`Integer`	`cps` The maximum number of connections that can be created per second on the NLB instance.
`Boolean`	`dryRun` Specifies whether to perform only a dry run without performing the actual request.
`Integer`	`endPort` The last port in the listener port range.
`Integer`	`idleTimeout` The timeout period of idle connections.
`String`	`listenerDescription` The name of the listener.
`Integer`	`listenerPort` The listener port.
`String`	`listenerProtocol` The listener protocol.
`String`	`loadBalancerId` The ID of the Network Load Balancer (NLB) instance.
`Integer`	`mss` The maximum size of a TCP segment.
`Boolean`	`proxyProtocolEnabled` Specifies whether to use the Proxy protocol to pass client IP addresses to backend servers.
`String`	`regionId` The region ID of the NLB instance.
`Boolean`	`secSensorEnabled` Specifies whether to enable fine-grained monitoring.
`String`	`securityPolicyId` The security policy ID.
`String`	`serverGroupId` The server group ID.
`Integer`	`startPort` The first port in the listener port range.
`List<CreateListenerRequest.CreateListenerRequestTag>`	`tag`

构造器概要

构造器
构造器和说明

CreateListenerRequest()

构造器
构造器和说明
`CreateListenerRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static CreateListenerRequest`	`build(Map<String,?> map)`
`Boolean`	`getAlpnEnabled()`
`String`	`getAlpnPolicy()`
`List<String>`	`getCaCertificateIds()`
`Boolean`	`getCaEnabled()`
`List<String>`	`getCertificateIds()`
`String`	`getClientToken()`
`Integer`	`getCps()`
`Boolean`	`getDryRun()`
`Integer`	`getEndPort()`
`Integer`	`getIdleTimeout()`
`String`	`getListenerDescription()`
`Integer`	`getListenerPort()`
`String`	`getListenerProtocol()`
`String`	`getLoadBalancerId()`
`Integer`	`getMss()`
`Boolean`	`getProxyProtocolEnabled()`
`String`	`getRegionId()`
`Boolean`	`getSecSensorEnabled()`
`String`	`getSecurityPolicyId()`
`String`	`getServerGroupId()`
`Integer`	`getStartPort()`
`List<CreateListenerRequest.CreateListenerRequestTag>`	`getTag()`
`CreateListenerRequest`	`setAlpnEnabled(Boolean alpnEnabled)`
`CreateListenerRequest`	`setAlpnPolicy(String alpnPolicy)`
`CreateListenerRequest`	`setCaCertificateIds(List<String> caCertificateIds)`
`CreateListenerRequest`	`setCaEnabled(Boolean caEnabled)`
`CreateListenerRequest`	`setCertificateIds(List<String> certificateIds)`
`CreateListenerRequest`	`setClientToken(String clientToken)`
`CreateListenerRequest`	`setCps(Integer cps)`
`CreateListenerRequest`	`setDryRun(Boolean dryRun)`
`CreateListenerRequest`	`setEndPort(Integer endPort)`
`CreateListenerRequest`	`setIdleTimeout(Integer idleTimeout)`
`CreateListenerRequest`	`setListenerDescription(String listenerDescription)`
`CreateListenerRequest`	`setListenerPort(Integer listenerPort)`
`CreateListenerRequest`	`setListenerProtocol(String listenerProtocol)`
`CreateListenerRequest`	`setLoadBalancerId(String loadBalancerId)`
`CreateListenerRequest`	`setMss(Integer mss)`
`CreateListenerRequest`	`setProxyProtocolEnabled(Boolean proxyProtocolEnabled)`
`CreateListenerRequest`	`setRegionId(String regionId)`
`CreateListenerRequest`	`setSecSensorEnabled(Boolean secSensorEnabled)`
`CreateListenerRequest`	`setSecurityPolicyId(String securityPolicyId)`
`CreateListenerRequest`	`setServerGroupId(String serverGroupId)`
`CreateListenerRequest`	`setStartPort(Integer startPort)`
`CreateListenerRequest`	`setTag(List<CreateListenerRequest.CreateListenerRequestTag> tag)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - alpnEnabled
```
@NameInMap(value="AlpnEnabled")
public Boolean alpnEnabled
```
    Specifies whether to enable Application-Layer Protocol Negotiation (ALPN). Valid values:
    
    * **true**
    
    * **false** (default)
  - alpnPolicy
```
@NameInMap(value="AlpnPolicy")
public String alpnPolicy
```
    The ALPN policy.
    
    Valid values:
    
    * HTTP1Only
    
    * HTTP2Only
    
    * HTTP2Preferred
    
    * HTTP2Optional
  - caCertificateIds
```
@NameInMap(value="CaCertificateIds")
public List<String> caCertificateIds
```
    The certificate authority (CA) certificates. This parameter takes effect only for listeners that use SSL over TCP.
    
    > You can specify only one CA certificate.
  - caEnabled
```
@NameInMap(value="CaEnabled")
public Boolean caEnabled
```
    Specifies whether to enable mutual authentication. Valid values:
    
    * **true**
    
    * **false** (default)
  - certificateIds
```
@NameInMap(value="CertificateIds")
public List<String> certificateIds
```
    The server certificates. This parameter takes effect only for listeners that use SSL over TCP.
    
    > You can specify only one server certificate.
  - clientToken
```
@NameInMap(value="ClientToken")
public String clientToken
```
    The client token that is used to ensure the idempotence of the request.
    
    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters.
    
    > If you do not specify this parameter, the system automatically uses the **request ID** as the **client token**. The **request ID** may be different for each request.
  - cps
```
@NameInMap(value="Cps")
public Integer cps
```
    The maximum number of connections that can be created per second on the NLB instance. Valid values: **0** to **1000000**. **0** specifies that the number of connections is unlimited.
  - dryRun
```
@NameInMap(value="DryRun")
public Boolean dryRun
```
    Specifies whether to perform only a dry run without performing the actual request. Valid values:
    
    * **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.
    
    * **false**(default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
  - endPort
```
@NameInMap(value="EndPort")
public Integer endPort
```
    The last port in the listener port range. Valid values: **0** to **65535**. The number of the last port must be greater than the number of the first port.
    
    > This parameter is required when **ListenerPort** is set to **0**.
  - idleTimeout
```
@NameInMap(value="IdleTimeout")
public Integer idleTimeout
```
    The timeout period of idle connections. Unit: seconds. Valid values: **1** to **900**. Default value: **900**.
  - listenerDescription
```
@NameInMap(value="ListenerDescription")
public String listenerDescription
```
    The name of the listener.
    
    The name must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (\_), and hyphens (-).
  - listenerPort
```
@NameInMap(value="ListenerPort")
public Integer listenerPort
```
    The listener port. Valid values: **0** to **65535**.
    
    If you set the value to **0**, the listener listens by port range. If you set the value to **0**, you must specify **StartPort** and **EndPort**.
  - listenerProtocol
```
@NameInMap(value="ListenerProtocol")
public String listenerProtocol
```
    The listener protocol. Valid values: **TCP**, **UDP**, and **TCPSSL**.
  - loadBalancerId
```
@NameInMap(value="LoadBalancerId")
public String loadBalancerId
```
    The ID of the Network Load Balancer (NLB) instance.
  - mss
```
@NameInMap(value="Mss")
public Integer mss
```
    The maximum size of a TCP segment. Unit: bytes. Valid values: **0** to **1500**. **0** specifies that the maximum segment size remains unchanged.
    
    > This parameter is supported only by TCP listeners and listeners that use SSL over TCP.
  - proxyProtocolEnabled
```
@NameInMap(value="ProxyProtocolEnabled")
public Boolean proxyProtocolEnabled
```
    Specifies whether to use the Proxy protocol to pass client IP addresses to backend servers. Valid values:
    
    * **true**
    
    * **false** (default)
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID of the NLB instance.
    
    You can call the [DescribeRegions](~~443657~~) operation to query the most recent region list.
  - secSensorEnabled
```
@NameInMap(value="SecSensorEnabled")
public Boolean secSensorEnabled
```
    Specifies whether to enable fine-grained monitoring. Valid values:
    
    * **true**
    
    * **false** (default)
  - securityPolicyId
```
@NameInMap(value="SecurityPolicyId")
public String securityPolicyId
```
    The security policy ID. System security policies and custom security policies are supported.
    
    Valid values: **tls_cipher_policy\_1\_0** (default), **tls_cipher_policy\_1\_1**, **tls_cipher_policy\_1\_2**, **tls_cipher_policy\_1\_2\_strict**, and **tls_cipher_policy\_1\_2\_strict_with\_1\_3**.
    
    > This parameter takes effect only for listeners that use SSL over TCP.
  - serverGroupId
```
@NameInMap(value="ServerGroupId")
public String serverGroupId
```
    The server group ID.
  - startPort
```
@NameInMap(value="StartPort")
public Integer startPort
```
    The first port in the listener port range. Valid values: **0** to **65535**.
    
    > This parameter is required when **ListenerPort** is set to **0**.
  - tag
```
@NameInMap(value="Tag")
public List<CreateListenerRequest.CreateListenerRequestTag> tag
```
- 构造器详细资料
  - CreateListenerRequest
```
public CreateListenerRequest()
```
- 方法详细资料
  - build
```
public static CreateListenerRequest build(Map<String,?> map)
                                   throws Exception
```
    抛出:
    
    Exception
  - setAlpnEnabled
```
public CreateListenerRequest setAlpnEnabled(Boolean alpnEnabled)
```
  - getAlpnEnabled
```
public Boolean getAlpnEnabled()
```
  - setAlpnPolicy
```
public CreateListenerRequest setAlpnPolicy(String alpnPolicy)
```
  - getAlpnPolicy
```
public String getAlpnPolicy()
```
  - setCaCertificateIds
```
public CreateListenerRequest setCaCertificateIds(List<String> caCertificateIds)
```
  - getCaCertificateIds
```
public List<String> getCaCertificateIds()
```
  - setCaEnabled
```
public CreateListenerRequest setCaEnabled(Boolean caEnabled)
```
  - getCaEnabled
```
public Boolean getCaEnabled()
```
  - setCertificateIds
```
public CreateListenerRequest setCertificateIds(List<String> certificateIds)
```
  - getCertificateIds
```
public List<String> getCertificateIds()
```
  - setClientToken
```
public CreateListenerRequest setClientToken(String clientToken)
```
  - getClientToken
```
public String getClientToken()
```
  - setCps
```
public CreateListenerRequest setCps(Integer cps)
```
  - getCps
```
public Integer getCps()
```
  - setDryRun
```
public CreateListenerRequest setDryRun(Boolean dryRun)
```
  - getDryRun
```
public Boolean getDryRun()
```
  - setEndPort
```
public CreateListenerRequest setEndPort(Integer endPort)
```
  - getEndPort
```
public Integer getEndPort()
```
  - setIdleTimeout
```
public CreateListenerRequest setIdleTimeout(Integer idleTimeout)
```
  - getIdleTimeout
```
public Integer getIdleTimeout()
```
  - setListenerDescription
```
public CreateListenerRequest setListenerDescription(String listenerDescription)
```
  - getListenerDescription
```
public String getListenerDescription()
```
  - setListenerPort
```
public CreateListenerRequest setListenerPort(Integer listenerPort)
```
  - getListenerPort
```
public Integer getListenerPort()
```
  - setListenerProtocol
```
public CreateListenerRequest setListenerProtocol(String listenerProtocol)
```
  - getListenerProtocol
```
public String getListenerProtocol()
```
  - setLoadBalancerId
```
public CreateListenerRequest setLoadBalancerId(String loadBalancerId)
```
  - getLoadBalancerId
```
public String getLoadBalancerId()
```
  - setMss
```
public CreateListenerRequest setMss(Integer mss)
```
  - getMss
```
public Integer getMss()
```
  - setProxyProtocolEnabled
```
public CreateListenerRequest setProxyProtocolEnabled(Boolean proxyProtocolEnabled)
```
  - getProxyProtocolEnabled
```
public Boolean getProxyProtocolEnabled()
```
  - setRegionId
```
public CreateListenerRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setSecSensorEnabled
```
public CreateListenerRequest setSecSensorEnabled(Boolean secSensorEnabled)
```
  - getSecSensorEnabled
```
public Boolean getSecSensorEnabled()
```
  - setSecurityPolicyId
```
public CreateListenerRequest setSecurityPolicyId(String securityPolicyId)
```
  - getSecurityPolicyId
```
public String getSecurityPolicyId()
```
  - setServerGroupId
```
public CreateListenerRequest setServerGroupId(String serverGroupId)
```
  - getServerGroupId
```
public String getServerGroupId()
```
  - setStartPort
```
public CreateListenerRequest setStartPort(Integer startPort)
```
  - getStartPort
```
public Integer getStartPort()
```
  - setTag
```
public CreateListenerRequest setTag(List<CreateListenerRequest.CreateListenerRequestTag> tag)
```
  - getTag
```
public List<CreateListenerRequest.CreateListenerRequestTag> getTag()
```

类 CreateListenerRequest

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

alpnEnabled

alpnPolicy

caCertificateIds

caEnabled

certificateIds

clientToken

cps

dryRun

endPort

idleTimeout

listenerDescription

listenerPort

listenerProtocol

loadBalancerId

mss

proxyProtocolEnabled

regionId

secSensorEnabled

securityPolicyId

serverGroupId

startPort

tag

构造器详细资料

CreateListenerRequest

方法详细资料

build

setAlpnEnabled

getAlpnEnabled

setAlpnPolicy

getAlpnPolicy

setCaCertificateIds

getCaCertificateIds

setCaEnabled

getCaEnabled

setCertificateIds

getCertificateIds

setClientToken

getClientToken

setCps

getCps

setDryRun

getDryRun

setEndPort

getEndPort

setIdleTimeout

getIdleTimeout

setListenerDescription

getListenerDescription

setListenerPort

getListenerPort

setListenerProtocol

getListenerProtocol

setLoadBalancerId

getLoadBalancerId

setMss

getMss

setProxyProtocolEnabled

getProxyProtocolEnabled

setRegionId

getRegionId

setSecSensorEnabled

getSecSensorEnabled

setSecurityPolicyId

getSecurityPolicyId

setServerGroupId

getServerGroupId

setStartPort

getStartPort

setTag

getTag