DescribeDisksRequest.Builder (alibabacloud-ecs20140526 2.0.3 API)

java.lang.Object
- com.aliyun.sdk.service.ecs20140526.models.DescribeDisksRequest.Builder

所有已实现的接口:

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

封闭类:

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`DescribeDisksRequest.Builder`	`additionalAttributes(List<String> additionalAttributes)` The values of attributes.
`DescribeDisksRequest.Builder`	`autoSnapshotPolicyId(String autoSnapshotPolicyId)` The ID of the automatic snapshot policy that is applied to the cloud disk.
`DescribeDisksRequest`	`build()`
`DescribeDisksRequest.Builder`	`category(String category)` The category of the disk.
`DescribeDisksRequest.Builder`	`deleteAutoSnapshot(Boolean deleteAutoSnapshot)` Specifies whether to delete the automatic snapshots of the cloud disk when the disk is released.
`DescribeDisksRequest.Builder`	`deleteWithInstance(Boolean deleteWithInstance)` Specifies whether to release the cloud disk when its associated instance is released.
`DescribeDisksRequest.Builder`	`diskChargeType(String diskChargeType)` The billing method of the disk.
`DescribeDisksRequest.Builder`	`diskIds(String diskIds)` The IDs of disks.
`DescribeDisksRequest.Builder`	`diskName(String diskName)` The name of the disk.
`DescribeDisksRequest.Builder`	`diskType(String diskType)` The type of the disk.
`DescribeDisksRequest.Builder`	`dryRun(Boolean dryRun)` Specifies whether to check the validity of the request without actually making the request.
`DescribeDisksRequest.Builder`	`enableAutomatedSnapshotPolicy(Boolean enableAutomatedSnapshotPolicy)` Specifies whether an automatic snapshot policy is applied to the cloud disk.
`DescribeDisksRequest.Builder`	`enableAutoSnapshot(Boolean enableAutoSnapshot)` Specifies whether the automatic snapshot policy feature is enabled for the cloud disk.
`DescribeDisksRequest.Builder`	`enableShared(Boolean enableShared)` Specifies whether the disk is a Shared Block Storage device.
`DescribeDisksRequest.Builder`	`encrypted(Boolean encrypted)` Specifies whether to query only encrypted cloud disks.
`DescribeDisksRequest.Builder`	`filter(List<DescribeDisksRequest.Filter> filter)` Filter.
`DescribeDisksRequest.Builder`	`instanceId(String instanceId)` The ID of the instance to which the disk is attached.
`DescribeDisksRequest.Builder`	`KMSKeyId(String KMSKeyId)` The ID of the Key Management Service (KMS) key used by the cloud disk.
`DescribeDisksRequest.Builder`	`lockReason(String lockReason)` The reason why the disk is locked.
`DescribeDisksRequest.Builder`	`maxResults(Integer maxResults)` The maximum number of entries to return on each page.
`DescribeDisksRequest.Builder`	`multiAttach(String multiAttach)` Specifies whether the multi-attach feature is enabled for the disk.
`DescribeDisksRequest.Builder`	`nextToken(String nextToken)` The query token.
`DescribeDisksRequest.Builder`	`ownerAccount(String ownerAccount)` OwnerAccount.
`DescribeDisksRequest.Builder`	`ownerId(Long ownerId)` OwnerId.
`DescribeDisksRequest.Builder`	`pageNumber(Integer pageNumber)` The number of the page to return.
`DescribeDisksRequest.Builder`	`pageSize(Integer pageSize)` The number of entries to return on each page.
`DescribeDisksRequest.Builder`	`portable(Boolean portable)` Specifies whether the disk is removable.
`DescribeDisksRequest.Builder`	`regionId(String regionId)` The region ID of the disk.
`DescribeDisksRequest.Builder`	`resourceGroupId(String resourceGroupId)` The ID of the resource group to which the disk belongs.
`DescribeDisksRequest.Builder`	`resourceOwnerAccount(String resourceOwnerAccount)` ResourceOwnerAccount.
`DescribeDisksRequest.Builder`	`resourceOwnerId(Long resourceOwnerId)` ResourceOwnerId.
`DescribeDisksRequest.Builder`	`snapshotId(String snapshotId)` The ID of the snapshot that was used to create the cloud disk.
`DescribeDisksRequest.Builder`	`sourceRegionId(String sourceRegionId)` SourceRegionId.
`DescribeDisksRequest.Builder`	`status(String status)` The state of the cloud disk.
`DescribeDisksRequest.Builder`	`tag(List<DescribeDisksRequest.Tag> tag)` The tags.
`DescribeDisksRequest.Builder`	`zoneId(String zoneId)` The zone ID of the disk.

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

- 方法详细资料
  - filter
```
public DescribeDisksRequest.Builder filter(List<DescribeDisksRequest.Filter> filter)
```
    Filter.
  - sourceRegionId
```
public DescribeDisksRequest.Builder sourceRegionId(String sourceRegionId)
```
    SourceRegionId.
  - additionalAttributes
```
public DescribeDisksRequest.Builder additionalAttributes(List<String> additionalAttributes)
```
    The values of attributes.
  - autoSnapshotPolicyId
```
public DescribeDisksRequest.Builder autoSnapshotPolicyId(String autoSnapshotPolicyId)
```
    The ID of the automatic snapshot policy that is applied to the cloud disk.
  - category
```
public DescribeDisksRequest.Builder category(String category)
```
    The category of the disk. Valid values:
    * all: all disk categories * cloud: basic disk * cloud_efficiency: ultra disk * cloud_ssd: standard SSD * cloud_essd: enhanced SSD (ESSD) * local\_ssd_pro: I/O-intensive local disk * local\_hdd_pro: throughput-intensive local disk * ephemeral: retired local disk * ephemeral_ssd: retired local SSD Default value: all.
  - deleteAutoSnapshot
```
public DescribeDisksRequest.Builder deleteAutoSnapshot(Boolean deleteAutoSnapshot)
```
    Specifies whether to delete the automatic snapshots of the cloud disk when the disk is released.
    * true: The automatic snapshots of the cloud disk are deleted when the disk is released. * false: The automatic snapshots of the cloud disk are not deleted when the disk is released. Default value: false.
  - deleteWithInstance
```
public DescribeDisksRequest.Builder deleteWithInstance(Boolean deleteWithInstance)
```
    Specifies whether to release the cloud disk when its associated instance is released. Valid values:
    * true: The cloud disk is released when its associated instance is released. * false: The cloud disk is not released but is retained as a pay-as-you-go data disk when its associated instance is released. Default value: false.
  - diskChargeType
```
public DescribeDisksRequest.Builder diskChargeType(String diskChargeType)
```
    The billing method of the disk. Valid values:
    * PrePaid: subscription * PostPaid: pay-as-you-go
  - diskIds
```
public DescribeDisksRequest.Builder diskIds(String diskIds)
```
    The IDs of disks. The value is a JSON array that consists of up to 100 disk IDs. Separate the disk IDs with commas (,).
  - diskName
```
public DescribeDisksRequest.Builder diskName(String diskName)
```
    The name of the disk.
  - diskType
```
public DescribeDisksRequest.Builder diskType(String diskType)
```
    The type of the disk. Valid values:
    * all: system disk and data disk * system: system disk * data: data disk Default value: all.
  - dryRun
```
public DescribeDisksRequest.Builder dryRun(Boolean dryRun)
```
    Specifies whether to check the validity of the request without actually making the request. Valid values:
    * true: The validity of the request is checked but the request is not made. Check items include whether your AccessKey pair is valid, whether Resource Access Management (RAM) users are granted required permissions, and whether the required parameters are specified. If the check fails, the corresponding error is returned. If the check succeeds, the `DryRunOperation` error code is returned. * false: The validity of the request is checked. If the check succeeds, a 2XX HTTP status code is returned, and the request is made. Default value: false.
  - enableAutoSnapshot
```
public DescribeDisksRequest.Builder enableAutoSnapshot(Boolean enableAutoSnapshot)
```
    Specifies whether the automatic snapshot policy feature is enabled for the cloud disk.
    * true: The automatic snapshot policy feature is enabled for the cloud disk. * false: The automatic snapshot policy feature is not enabled for the cloud disk. > By default, the automatic snapshot policy feature is enabled for created cloud disks. You only need to apply an automatic snapshot policy to a cloud disk before you can use the automatic snapshot policy.
  - enableAutomatedSnapshotPolicy
```
public DescribeDisksRequest.Builder enableAutomatedSnapshotPolicy(Boolean enableAutomatedSnapshotPolicy)
```
    Specifies whether an automatic snapshot policy is applied to the cloud disk.
    * true: An automatic snapshot policy is applied to the cloud disk. * false: No automatic snapshot policy is applied to the cloud disk. Default value: false.
  - enableShared
```
public DescribeDisksRequest.Builder enableShared(Boolean enableShared)
```
    Specifies whether the disk is a Shared Block Storage device.
  - encrypted
```
public DescribeDisksRequest.Builder encrypted(Boolean encrypted)
```
    Specifies whether to query only encrypted cloud disks.
    * true: queries only encrypted cloud disks. * false: does not query encrypted cloud disks. Default value: false.
  - instanceId
```
public DescribeDisksRequest.Builder instanceId(String instanceId)
```
    The ID of the instance to which the disk is attached.
  - KMSKeyId
```
public DescribeDisksRequest.Builder KMSKeyId(String KMSKeyId)
```
    The ID of the Key Management Service (KMS) key used by the cloud disk.
  - lockReason
```
public DescribeDisksRequest.Builder lockReason(String lockReason)
```
    The reason why the disk is locked. Valid values:
    * financial: The disk is locked due to overdue payments. * security: The disk is locked due to security reasons. * recycling: The preemptible instance is locked and pending release. * dedicatedhostfinancial: The instance is locked due to overdue payments for the dedicated host.
  - maxResults
```
public DescribeDisksRequest.Builder maxResults(Integer maxResults)
```
    The maximum number of entries to return on each page. Valid values: 1 to 500.
    Default value: * If this parameter is not specified or is set to a value smaller than 10, the default value is 10. * If this parameter is set to a value greater than 500, the default value is 500.
  - multiAttach
```
public DescribeDisksRequest.Builder multiAttach(String multiAttach)
```
    Specifies whether the multi-attach feature is enabled for the disk. Valid values:
    * Disabled: The multi-attach feature is not enabled for the disk. * Enabled: The multi-attach feature is enabled for the disk. * LegacyShared: Shared Block Storage devices are queried. The multi-attach feature is in invitational preview. To use this feature, [submit a ticket](https://workorder-intl.console.aliyun.com/console.htm#/ticket/list).
  - nextToken
```
public DescribeDisksRequest.Builder nextToken(String nextToken)
```
    The query token. Set the value to the `NextToken` value returned in the last call to the Describedisks operation.
    For more information about how to check the responses returned by this operation, see the preceding "Description" section.
  - ownerAccount
```
public DescribeDisksRequest.Builder ownerAccount(String ownerAccount)
```
    OwnerAccount.
  - ownerId
```
public DescribeDisksRequest.Builder ownerId(Long ownerId)
```
    OwnerId.
  - pageNumber
```
public DescribeDisksRequest.Builder pageNumber(Integer pageNumber)
```
    The number of the page to return.
    Page start from page 1. Default value: 1.
  - pageSize
```
public DescribeDisksRequest.Builder pageSize(Integer pageSize)
```
    The number of entries to return on each page.
    Maximum value: 100 Default value: 10.
  - portable
```
public DescribeDisksRequest.Builder portable(Boolean portable)
```
    Specifies whether the disk is removable. Valid values:
    * true: The disk is removable. A removable disk can independently exist and can be attached to or detached from an instance within the same zone. * false: The disk is not removable. A disk that is not removable cannot independently exist or be attached to or detached from an instance within the same zone. The `Portable` attribute of the following disks is `false`, and these disks share the same lifecycle with their associated instances: * Local disks * Local SSDs * Subscription data disks
  - regionId
```
public DescribeDisksRequest.Builder regionId(String regionId)
```
    The region ID of the disk. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.
  - resourceGroupId
```
public DescribeDisksRequest.Builder resourceGroupId(String resourceGroupId)
```
    The ID of the resource group to which the disk belongs. If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.
    > Resources in the default resource group are displayed in the response regardless of how this parameter is set.
  - resourceOwnerAccount
```
public DescribeDisksRequest.Builder resourceOwnerAccount(String resourceOwnerAccount)
```
    ResourceOwnerAccount.
  - resourceOwnerId
```
public DescribeDisksRequest.Builder resourceOwnerId(Long resourceOwnerId)
```
    ResourceOwnerId.
  - snapshotId
```
public DescribeDisksRequest.Builder snapshotId(String snapshotId)
```
    The ID of the snapshot that was used to create the cloud disk.
  - status
```
public DescribeDisksRequest.Builder status(String status)
```
    The state of the cloud disk. For more information, see [Disk states](~~25689~~). Valid values:
    * In_use * Available * Attaching * Detaching * Creating * ReIniting * All Default value: All.
  - tag
```
public DescribeDisksRequest.Builder tag(List<DescribeDisksRequest.Tag> tag)
```
    The tags.
  - zoneId
```
public DescribeDisksRequest.Builder zoneId(String zoneId)
```
    The zone ID of the disk.
  - build
```
public DescribeDisksRequest build()
```

类 DescribeDisksRequest.Builder

方法概要

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

方法详细资料

filter

sourceRegionId

additionalAttributes

autoSnapshotPolicyId

category

deleteAutoSnapshot

deleteWithInstance

diskChargeType

diskIds

diskName

diskType

dryRun

enableAutoSnapshot

enableAutomatedSnapshotPolicy

enableShared

encrypted

instanceId

KMSKeyId

lockReason

maxResults

multiAttach

nextToken

ownerAccount

ownerId

pageNumber

pageSize

portable

regionId

resourceGroupId

resourceOwnerAccount

resourceOwnerId

snapshotId

status

tag

zoneId

build