CreateDesktopGroupRequest.Builder (alibabacloud-ecd20200930 4.0.9 API)

java.lang.Object
- com.aliyun.sdk.service.ecd20200930.models.CreateDesktopGroupRequest.Builder

所有已实现的接口:

darabonba.core.RequestModel.Builder<CreateDesktopGroupRequest,CreateDesktopGroupRequest.Builder>

封闭类:

CreateDesktopGroupRequest
```
public static final class CreateDesktopGroupRequest.Builder
extends Object
```

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CreateDesktopGroupRequest.Builder`	`allClassifyUsers(Boolean allClassifyUsers)` The end users whom you want to add to all types of desktop groups.
`CreateDesktopGroupRequest.Builder`	`allowAutoSetup(Integer allowAutoSetup)` Specifies whether to automatically create cloud desktops in the desktop group if you set the billing method to subscription.
`CreateDesktopGroupRequest.Builder`	`allowBufferCount(Integer allowBufferCount)` Specifies whether to reserve cloud desktops if you set the billing method to pay-as-you-go.
`CreateDesktopGroupRequest.Builder`	`autoPay(Boolean autoPay)` Specifies whether to enable automatic payment.
`CreateDesktopGroupRequest.Builder`	`autoRenew(Boolean autoRenew)` Specifies whether to enable auto-renewal.
`CreateDesktopGroupRequest.Builder`	`bindAmount(Long bindAmount)` The number of sessions that are allowed per cloud desktop in a multi-session desktop group.
`CreateDesktopGroupRequest`	`build()`
`CreateDesktopGroupRequest.Builder`	`bundleId(String bundleId)` The ID of the desktop template.
`CreateDesktopGroupRequest.Builder`	`buyDesktopsCount(Integer buyDesktopsCount)` The number of cloud desktops that you want to purchase.
`CreateDesktopGroupRequest.Builder`	`chargeType(String chargeType)` The billing method of the cloud desktops in the desktop group.
`CreateDesktopGroupRequest.Builder`	`classify(String classify)` The type of the desktop group.
`CreateDesktopGroupRequest.Builder`	`clientToken(String clientToken)` The client token that is used to ensure the idempotence of the request.
`CreateDesktopGroupRequest.Builder`	`comments(String comments)` The remarks on the desktop group.
`CreateDesktopGroupRequest.Builder`	`connectDuration(Long connectDuration)` The maximum period of time during which the session is connected.
`CreateDesktopGroupRequest.Builder`	`defaultInitDesktopCount(Integer defaultInitDesktopCount)` The default number of cloud desktops to create when you create the desktop group.
`CreateDesktopGroupRequest.Builder`	`desktopGroupName(String desktopGroupName)` The name of the desktop group.
`CreateDesktopGroupRequest.Builder`	`directoryId(String directoryId)` The ID of the directory.
`CreateDesktopGroupRequest.Builder`	`endUserIds(List<String> endUserIds)` The end users that can use the desktop group.
`CreateDesktopGroupRequest.Builder`	`fileSystemId(String fileSystemId)` The Apsara File Storage NAS (NAS) file system that is used after data roaming is enabled.
`CreateDesktopGroupRequest.Builder`	`groupVersion(Integer groupVersion)` The desktop group version.
`CreateDesktopGroupRequest.Builder`	`idleDisconnectDuration(Long idleDisconnectDuration)` The maximum period of time for which a session remains idle.
`CreateDesktopGroupRequest.Builder`	`keepDuration(Long keepDuration)` The retention period of the cloud desktop after the end user disconnects from the cloud desktop.
`CreateDesktopGroupRequest.Builder`	`loadPolicy(Long loadPolicy)` The load balancing policy of the multi-session desktop group.
`CreateDesktopGroupRequest.Builder`	`maxDesktopsCount(Integer maxDesktopsCount)` The maximum number of cloud desktops that the desktop group can contain.
`CreateDesktopGroupRequest.Builder`	`minDesktopsCount(Integer minDesktopsCount)` The minimum number of cloud desktops that must be contained in the desktop group if you set the billing method to subscription.
`CreateDesktopGroupRequest.Builder`	`officeSiteId(String officeSiteId)` The ID of the workspace.
`CreateDesktopGroupRequest.Builder`	`ownType(Integer ownType)` The type of the desktop group.
`CreateDesktopGroupRequest.Builder`	`period(Integer period)` The subscription period of the cloud desktops in the desktop group.
`CreateDesktopGroupRequest.Builder`	`periodUnit(String periodUnit)` The unit of the subscription duration.
`CreateDesktopGroupRequest.Builder`	`policyGroupId(String policyGroupId)` The ID of the policy.
`CreateDesktopGroupRequest.Builder`	`profileFollowSwitch(Boolean profileFollowSwitch)` Specifies whether to enable data roaming.
`CreateDesktopGroupRequest.Builder`	`promotionId(String promotionId)` PromotionId.
`CreateDesktopGroupRequest.Builder`	`ratioThreshold(Float ratioThreshold)` The threshold for the ratio of connected sessions.
`CreateDesktopGroupRequest.Builder`	`regionId(String regionId)` The ID of the region.
`CreateDesktopGroupRequest.Builder`	`resetType(Long resetType)` Specifies which type of the disk to reset for cloud desktops in the desktop group.
`CreateDesktopGroupRequest.Builder`	`scaleStrategyId(String scaleStrategyId)` The ID of the scaling policy.
`CreateDesktopGroupRequest.Builder`	`stopDuration(Long stopDuration)` The period of time before the idle cloud desktop is stopped.
`CreateDesktopGroupRequest.Builder`	`tag(List<CreateDesktopGroupRequest.Tag> tag)` The tags that you want to attach to the cloud computer pool.
`CreateDesktopGroupRequest.Builder`	`volumeEncryptionEnabled(Boolean volumeEncryptionEnabled)` Specifies whether to enable disk encryption.
`CreateDesktopGroupRequest.Builder`	`volumeEncryptionKey(String volumeEncryptionKey)` The ID of the Key Management Service (KMS) key that you want to use when disk encryption is enabled.
`CreateDesktopGroupRequest.Builder`	`vpcId(String vpcId)` The ID of the virtual private cloud (VPC) in which you want to create the desktop group.

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

- 方法详细资料
  - allClassifyUsers
```
public CreateDesktopGroupRequest.Builder allClassifyUsers(Boolean allClassifyUsers)
```
    The end users whom you want to add to all types of desktop groups.
  - allowAutoSetup
```
public CreateDesktopGroupRequest.Builder allowAutoSetup(Integer allowAutoSetup)
```
    Specifies whether to automatically create cloud desktops in the desktop group if you set the billing method to subscription. If you set the ChargeType parameter to PrePaid, this parameter is required.
  - allowBufferCount
```
public CreateDesktopGroupRequest.Builder allowBufferCount(Integer allowBufferCount)
```
    Specifies whether to reserve cloud desktops if you set the billing method to pay-as-you-go. If you set the ChargeType parameter to PostPaid, this parameter is required. Valid values: 0: does not allow the system to reserve cloud desktops. N: allows the system to reserve N cloud desktops. The variable N must be an integer that ranges from 1 to 100.
  - autoPay
```
public CreateDesktopGroupRequest.Builder autoPay(Boolean autoPay)
```
    Specifies whether to enable automatic payment.
  - autoRenew
```
public CreateDesktopGroupRequest.Builder autoRenew(Boolean autoRenew)
```
    Specifies whether to enable auto-renewal.
    Valid values: * true * false
  - bindAmount
```
public CreateDesktopGroupRequest.Builder bindAmount(Long bindAmount)
```
    The number of sessions that are allowed per cloud desktop in a multi-session desktop group.
  - bundleId
```
public CreateDesktopGroupRequest.Builder bundleId(String bundleId)
```
    The ID of the desktop template.
  - buyDesktopsCount
```
public CreateDesktopGroupRequest.Builder buyDesktopsCount(Integer buyDesktopsCount)
```
    The number of cloud desktops that you want to purchase. Valid values: 0 to 200.
  - chargeType
```
public CreateDesktopGroupRequest.Builder chargeType(String chargeType)
```
    The billing method of the cloud desktops in the desktop group.
  - classify
```
public CreateDesktopGroupRequest.Builder classify(String classify)
```
    The type of the desktop group.
  - clientToken
```
public CreateDesktopGroupRequest.Builder clientToken(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 make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).
  - comments
```
public CreateDesktopGroupRequest.Builder comments(String comments)
```
    The remarks on the desktop group.
  - connectDuration
```
public CreateDesktopGroupRequest.Builder connectDuration(Long connectDuration)
```
    The maximum period of time during which the session is connected. When the specified maximum period of time is reached, the session automatically disconnects. Unit: milliseconds. This parameter is required only for cloud desktops in the same desktop group.
  - defaultInitDesktopCount
```
public CreateDesktopGroupRequest.Builder defaultInitDesktopCount(Integer defaultInitDesktopCount)
```
    The default number of cloud desktops to create when you create the desktop group. Default value: 1.
  - desktopGroupName
```
public CreateDesktopGroupRequest.Builder desktopGroupName(String desktopGroupName)
```
    The name of the desktop group.
  - directoryId
```
public CreateDesktopGroupRequest.Builder directoryId(String directoryId)
```
    The ID of the directory.
  - endUserIds
```
public CreateDesktopGroupRequest.Builder endUserIds(List<String> endUserIds)
```
    The end users that can use the desktop group.
  - fileSystemId
```
public CreateDesktopGroupRequest.Builder fileSystemId(String fileSystemId)
```
    The Apsara File Storage NAS (NAS) file system that is used after data roaming is enabled.
  - groupVersion
```
public CreateDesktopGroupRequest.Builder groupVersion(Integer groupVersion)
```
    The desktop group version.
  - idleDisconnectDuration
```
public CreateDesktopGroupRequest.Builder idleDisconnectDuration(Long idleDisconnectDuration)
```
    The maximum period of time for which a session remains idle. If an end user performs no operations on a cloud desktop by using keyboards or mouses during a session, the session becomes idle. When the specified maximum period of time is reached, the session automatically disconnects. Unit: milliseconds. This parameter is required only for cloud desktops in the same desktop group.
  - keepDuration
```
public CreateDesktopGroupRequest.Builder keepDuration(Long keepDuration)
```
    The retention period of the cloud desktop after the end user disconnects from the cloud desktop. Unit: milliseconds.
  - loadPolicy
```
public CreateDesktopGroupRequest.Builder loadPolicy(Long loadPolicy)
```
    The load balancing policy of the multi-session desktop group.
  - maxDesktopsCount
```
public CreateDesktopGroupRequest.Builder maxDesktopsCount(Integer maxDesktopsCount)
```
    The maximum number of cloud desktops that the desktop group can contain. Valid values: 0 to 200.
  - minDesktopsCount
```
public CreateDesktopGroupRequest.Builder minDesktopsCount(Integer minDesktopsCount)
```
    The minimum number of cloud desktops that must be contained in the desktop group if you set the billing method to subscription. If you set the ChargeType parameter to PrePaid, this parameter is required. Valid values: 0 to the value of MaxDesktopsCount. Default value: 1.
  - officeSiteId
```
public CreateDesktopGroupRequest.Builder officeSiteId(String officeSiteId)
```
    The ID of the workspace.
  - ownType
```
public CreateDesktopGroupRequest.Builder ownType(Integer ownType)
```
    The type of the desktop group.
  - period
```
public CreateDesktopGroupRequest.Builder period(Integer period)
```
    The subscription period of the cloud desktops in the desktop group. The unit is specified by the PeriodUnit parameter. The Period parameter takes effect only if you set the ChargeType parameter to PrePaid.
    * Valid values if you set the PeriodUnit parameter to Month: * 1 * 2 * 3 * 6 * Valid values if you set the PeriodUnit parameter to Year: * 1 * 2 * 3 * 4 * 5
  - periodUnit
```
public CreateDesktopGroupRequest.Builder periodUnit(String periodUnit)
```
    The unit of the subscription duration.
  - policyGroupId
```
public CreateDesktopGroupRequest.Builder policyGroupId(String policyGroupId)
```
    The ID of the policy.
  - profileFollowSwitch
```
public CreateDesktopGroupRequest.Builder profileFollowSwitch(Boolean profileFollowSwitch)
```
    Specifies whether to enable data roaming.
  - promotionId
```
public CreateDesktopGroupRequest.Builder promotionId(String promotionId)
```
    PromotionId.
  - ratioThreshold
```
public CreateDesktopGroupRequest.Builder ratioThreshold(Float ratioThreshold)
```
    The threshold for the ratio of connected sessions. This parameter is the condition that triggers auto scaling in a multi-session desktop group. `Ratio of connected sessions = Number of connected sessions/(Total number of cloud desktops × Maximum number of sessions allowed for each cloud desktop) × 100%`. When the specified threshold is reached, new cloud desktops are automatically created. When the specified threshold is not reached, idle cloud desktops are released.
  - regionId
```
public CreateDesktopGroupRequest.Builder regionId(String regionId)
```
    The ID of the region.
  - resetType
```
public CreateDesktopGroupRequest.Builder resetType(Long resetType)
```
    Specifies which type of the disk to reset for cloud desktops in the desktop group.
  - scaleStrategyId
```
public CreateDesktopGroupRequest.Builder scaleStrategyId(String scaleStrategyId)
```
    The ID of the scaling policy.
    > This parameter is unavailable.
  - stopDuration
```
public CreateDesktopGroupRequest.Builder stopDuration(Long stopDuration)
```
    The period of time before the idle cloud desktop is stopped. When the specified period of time is reached, the idle cloud desktop automatically stops. If an end user connects to a stopped cloud desktop, the cloud desktop automatically starts. Unit: milliseconds.
  - tag
```
public CreateDesktopGroupRequest.Builder tag(List<CreateDesktopGroupRequest.Tag> tag)
```
    The tags that you want to attach to the cloud computer pool. You can specify 1 to 20 tags.
  - volumeEncryptionEnabled
```
public CreateDesktopGroupRequest.Builder volumeEncryptionEnabled(Boolean volumeEncryptionEnabled)
```
    Specifies whether to enable disk encryption.
  - volumeEncryptionKey
```
public CreateDesktopGroupRequest.Builder volumeEncryptionKey(String volumeEncryptionKey)
```
    The ID of the Key Management Service (KMS) key that you want to use when disk encryption is enabled. You can call the [ListKeys](~~28951~~) operation to obtain a list of KMS keys.
  - vpcId
```
public CreateDesktopGroupRequest.Builder vpcId(String vpcId)
```
    The ID of the virtual private cloud (VPC) in which you want to create the desktop group.
  - build
```
public CreateDesktopGroupRequest build()
```

类 CreateDesktopGroupRequest.Builder

方法概要

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

方法详细资料

allClassifyUsers

allowAutoSetup

allowBufferCount

autoPay

autoRenew

bindAmount

bundleId

buyDesktopsCount

chargeType

classify

clientToken

comments

connectDuration

defaultInitDesktopCount

desktopGroupName

directoryId

endUserIds

fileSystemId

groupVersion

idleDisconnectDuration

keepDuration

loadPolicy

maxDesktopsCount

minDesktopsCount

officeSiteId

ownType

period

periodUnit

policyGroupId

profileFollowSwitch

promotionId

ratioThreshold

regionId

resetType

scaleStrategyId

stopDuration

tag

volumeEncryptionEnabled

volumeEncryptionKey

vpcId

build