CreateServerGroupRequest (nlb20220430 1.1.0 API)

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

public class CreateServerGroupRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`CreateServerGroupRequest.CreateServerGroupRequestHealthCheckConfig`
`static class`	`CreateServerGroupRequest.CreateServerGroupRequestTag`

字段概要

字段
限定符和类型	字段和说明
`String`	`addressIPVersion` The protocol version.
`Boolean`	`anyPortEnabled` Specifies whether to enable all-port forwarding.
`String`	`clientToken` The client token that is used to ensure the idempotence of the request.
`Boolean`	`connectionDrainEnabled` Specifies whether to enable connection draining.
`Integer`	`connectionDrainTimeout` The timeout period of connection draining.
`Boolean`	`dryRun` Specifies whether to perform a dry run, without performing the actual request.
`CreateServerGroupRequest.CreateServerGroupRequestHealthCheckConfig`	`healthCheckConfig` The configurations of the health check feature.
`Boolean`	`preserveClientIpEnabled` Specifies whether to enable client IP preservation.
`String`	`protocol` The protocol used to forward requests to the backend servers.
`String`	`regionId` The region ID of the NLB instance.
`String`	`resourceGroupId` The ID of the resource group to which the server group belongs.
`String`	`scheduler` The scheduling algorithm.
`String`	`serverGroupName` The name of the server group.
`String`	`serverGroupType` The type of server group.
`List<CreateServerGroupRequest.CreateServerGroupRequestTag>`	`tag` The tags.
`String`	`vpcId` The ID of the virtual private cloud (VPC) to which the server group belongs.

构造器概要

构造器
构造器和说明

CreateServerGroupRequest()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static CreateServerGroupRequest`	`build(Map<String,?> map)`
`String`	`getAddressIPVersion()`
`Boolean`	`getAnyPortEnabled()`
`String`	`getClientToken()`
`Boolean`	`getConnectionDrainEnabled()`
`Integer`	`getConnectionDrainTimeout()`
`Boolean`	`getDryRun()`
`CreateServerGroupRequest.CreateServerGroupRequestHealthCheckConfig`	`getHealthCheckConfig()`
`Boolean`	`getPreserveClientIpEnabled()`
`String`	`getProtocol()`
`String`	`getRegionId()`
`String`	`getResourceGroupId()`
`String`	`getScheduler()`
`String`	`getServerGroupName()`
`String`	`getServerGroupType()`
`List<CreateServerGroupRequest.CreateServerGroupRequestTag>`	`getTag()`
`String`	`getVpcId()`
`CreateServerGroupRequest`	`setAddressIPVersion(String addressIPVersion)`
`CreateServerGroupRequest`	`setAnyPortEnabled(Boolean anyPortEnabled)`
`CreateServerGroupRequest`	`setClientToken(String clientToken)`
`CreateServerGroupRequest`	`setConnectionDrainEnabled(Boolean connectionDrainEnabled)`
`CreateServerGroupRequest`	`setConnectionDrainTimeout(Integer connectionDrainTimeout)`
`CreateServerGroupRequest`	`setDryRun(Boolean dryRun)`
`CreateServerGroupRequest`	`setHealthCheckConfig(CreateServerGroupRequest.CreateServerGroupRequestHealthCheckConfig healthCheckConfig)`
`CreateServerGroupRequest`	`setPreserveClientIpEnabled(Boolean preserveClientIpEnabled)`
`CreateServerGroupRequest`	`setProtocol(String protocol)`
`CreateServerGroupRequest`	`setRegionId(String regionId)`
`CreateServerGroupRequest`	`setResourceGroupId(String resourceGroupId)`
`CreateServerGroupRequest`	`setScheduler(String scheduler)`
`CreateServerGroupRequest`	`setServerGroupName(String serverGroupName)`
`CreateServerGroupRequest`	`setServerGroupType(String serverGroupType)`
`CreateServerGroupRequest`	`setTag(List<CreateServerGroupRequest.CreateServerGroupRequestTag> tag)`
`CreateServerGroupRequest`	`setVpcId(String vpcId)`

从类继承的方法 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

- 字段详细资料
  - addressIPVersion
```
@NameInMap(value="AddressIPVersion")
public String addressIPVersion
```
    The protocol version. Valid values:
    
    * **ipv4** (default): IPv4
    
    * **DualStack**: dual stack
  - anyPortEnabled
```
@NameInMap(value="AnyPortEnabled")
public Boolean anyPortEnabled
```
    Specifies whether to enable all-port forwarding. Valid values:
    
    * **true**
    
    * **false** (default)
  - 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 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.
  - connectionDrainEnabled
```
@NameInMap(value="ConnectionDrainEnabled")
public Boolean connectionDrainEnabled
```
    Specifies whether to enable connection draining. Valid values:
    
    * **true**
    
    * **false** (default)
  - connectionDrainTimeout
```
@NameInMap(value="ConnectionDrainTimeout")
public Integer connectionDrainTimeout
```
    The timeout period of connection draining. Unit: seconds. Valid values: **10** to **900**.
  - dryRun
```
@NameInMap(value="DryRun")
public Boolean dryRun
```
    Specifies whether to perform 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.
  - healthCheckConfig
```
@NameInMap(value="HealthCheckConfig")
public CreateServerGroupRequest.CreateServerGroupRequestHealthCheckConfig healthCheckConfig
```
    The configurations of the health check feature.
  - preserveClientIpEnabled
```
@NameInMap(value="PreserveClientIpEnabled")
public Boolean preserveClientIpEnabled
```
    Specifies whether to enable client IP preservation. Valid values:
    
    * **true**
    
    * **false** (default)
  - protocol
```
@NameInMap(value="Protocol")
public String protocol
```
    The protocol used to forward requests to the backend servers. Valid values:
    
    * **TCP** (default)
    
    * **UDP**
    
    * **TCPSSL**
  - 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.
  - resourceGroupId
```
@NameInMap(value="ResourceGroupId")
public String resourceGroupId
```
    The ID of the resource group to which the server group belongs.
  - scheduler
```
@NameInMap(value="Scheduler")
public String scheduler
```
    The scheduling algorithm. Valid values:
    
    * **Wrr:** The weighted round-robin algorithm is used. Backend servers with higher weights receive more requests than backend servers with lower weights. This is the default value.
    
    * **rr:** The round-robin algorithm is used. Requests are forwarded to backend servers in sequence.
    
    * **sch:** Source IP hashing is used. Requests from the same source IP address are forwarded to the same backend server.
    
    * **tch:** Four-element hashing is used. It specifies consistent hashing that is based on four factors: source IP address, destination IP address, source port, and destination port. Requests that contain the same information based on the four factors are forwarded to the same backend server.
    
    * **qch**: QUIC ID hashing. Requests that contain the same QUIC ID are forwarded to the same backend server.
  - serverGroupName
```
@NameInMap(value="ServerGroupName")
public String serverGroupName
```
    The name of the server group.
    
    The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (\_), and hyphens (-). The name must start with a letter.
  - serverGroupType
```
@NameInMap(value="ServerGroupType")
public String serverGroupType
```
    The type of server group. Valid values:
    
    * **Instance**: allows you to add servers of the **Ecs**, **Ens**, or **Eci** type. This is the default value.
    
    * **Ip**: allows you to add servers by specifying IP addresses.
  - tag
```
@NameInMap(value="Tag")
public List<CreateServerGroupRequest.CreateServerGroupRequestTag> tag
```
    The tags.
  - vpcId
```
@NameInMap(value="VpcId")
public String vpcId
```
    The ID of the virtual private cloud (VPC) to which the server group belongs.
    
    > If **ServerGroupType** is set to **Instance**, only servers in the specified VPC can be added to the server group.
- 构造器详细资料
  - CreateServerGroupRequest
```
public CreateServerGroupRequest()
```
- 方法详细资料
  - build
```
public static CreateServerGroupRequest build(Map<String,?> map)
                                      throws Exception
```
    抛出:
    
    Exception
  - setAddressIPVersion
```
public CreateServerGroupRequest setAddressIPVersion(String addressIPVersion)
```
  - getAddressIPVersion
```
public String getAddressIPVersion()
```
  - setAnyPortEnabled
```
public CreateServerGroupRequest setAnyPortEnabled(Boolean anyPortEnabled)
```
  - getAnyPortEnabled
```
public Boolean getAnyPortEnabled()
```
  - setClientToken
```
public CreateServerGroupRequest setClientToken(String clientToken)
```
  - getClientToken
```
public String getClientToken()
```
  - setConnectionDrainEnabled
```
public CreateServerGroupRequest setConnectionDrainEnabled(Boolean connectionDrainEnabled)
```
  - getConnectionDrainEnabled
```
public Boolean getConnectionDrainEnabled()
```
  - setConnectionDrainTimeout
```
public CreateServerGroupRequest setConnectionDrainTimeout(Integer connectionDrainTimeout)
```
  - getConnectionDrainTimeout
```
public Integer getConnectionDrainTimeout()
```
  - setDryRun
```
public CreateServerGroupRequest setDryRun(Boolean dryRun)
```
  - getDryRun
```
public Boolean getDryRun()
```
  - setHealthCheckConfig
```
public CreateServerGroupRequest setHealthCheckConfig(CreateServerGroupRequest.CreateServerGroupRequestHealthCheckConfig healthCheckConfig)
```
  - getHealthCheckConfig
```
public CreateServerGroupRequest.CreateServerGroupRequestHealthCheckConfig getHealthCheckConfig()
```
  - setPreserveClientIpEnabled
```
public CreateServerGroupRequest setPreserveClientIpEnabled(Boolean preserveClientIpEnabled)
```
  - getPreserveClientIpEnabled
```
public Boolean getPreserveClientIpEnabled()
```
  - setProtocol
```
public CreateServerGroupRequest setProtocol(String protocol)
```
  - getProtocol
```
public String getProtocol()
```
  - setRegionId
```
public CreateServerGroupRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setResourceGroupId
```
public CreateServerGroupRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setScheduler
```
public CreateServerGroupRequest setScheduler(String scheduler)
```
  - getScheduler
```
public String getScheduler()
```
  - setServerGroupName
```
public CreateServerGroupRequest setServerGroupName(String serverGroupName)
```
  - getServerGroupName
```
public String getServerGroupName()
```
  - setServerGroupType
```
public CreateServerGroupRequest setServerGroupType(String serverGroupType)
```
  - getServerGroupType
```
public String getServerGroupType()
```
  - setTag
```
public CreateServerGroupRequest setTag(List<CreateServerGroupRequest.CreateServerGroupRequestTag> tag)
```
  - getTag
```
public List<CreateServerGroupRequest.CreateServerGroupRequestTag> getTag()
```
  - setVpcId
```
public CreateServerGroupRequest setVpcId(String vpcId)
```
  - getVpcId
```
public String getVpcId()
```

类 CreateServerGroupRequest

嵌套类概要

字段概要

构造器概要

方法概要

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

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

字段详细资料

addressIPVersion

anyPortEnabled

clientToken

connectionDrainEnabled

connectionDrainTimeout

dryRun

healthCheckConfig

preserveClientIpEnabled

protocol

regionId

resourceGroupId

scheduler

serverGroupName

serverGroupType

tag

vpcId

构造器详细资料

CreateServerGroupRequest

方法详细资料

build

setAddressIPVersion

getAddressIPVersion

setAnyPortEnabled

getAnyPortEnabled

setClientToken

getClientToken

setConnectionDrainEnabled

getConnectionDrainEnabled

setConnectionDrainTimeout

getConnectionDrainTimeout

setDryRun

getDryRun

setHealthCheckConfig

getHealthCheckConfig

setPreserveClientIpEnabled

getPreserveClientIpEnabled

setProtocol

getProtocol

setRegionId

getRegionId

setResourceGroupId

getResourceGroupId

setScheduler

getScheduler

setServerGroupName

getServerGroupName

setServerGroupType

getServerGroupType

setTag

getTag

setVpcId

getVpcId