CreateSnapshotRequest (ecs20140526 3.1.10 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.ecs20140526.models.CreateSnapshotRequest

public class CreateSnapshotRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

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

static class CreateSnapshotRequest.CreateSnapshotRequestTag

嵌套类
限定符和类型	类和说明
`static class`	`CreateSnapshotRequest.CreateSnapshotRequestTag`

字段概要

字段
限定符和类型	字段和说明
`String`	`category` The category of the snapshot.
`String`	`clientToken` The client token that is used to ensure the idempotence of the request.
`String`	`description` The description of the snapshot.
`String`	`diskId` The ID of the disk.
`Boolean`	`instantAccess` Specifies whether to enable the instant access feature.
`Integer`	`instantAccessRetentionDays` The validity period of the instant access feature.
`String`	`ownerAccount`
`Long`	`ownerId`
`String`	`resourceGroupId` The ID of the resource group to which you want to assign the snapshot.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`Integer`	`retentionDays` The retention period of the snapshot.
`String`	`snapshotName` The name of the snapshot.
`String`	`storageLocationArn` > This parameter is unavailable.
`List<CreateSnapshotRequest.CreateSnapshotRequestTag>`	`tag` The tags that you want to add to the snapshot.

构造器概要

构造器
构造器和说明

CreateSnapshotRequest()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static CreateSnapshotRequest`	`build(Map<String,?> map)`
`String`	`getCategory()`
`String`	`getClientToken()`
`String`	`getDescription()`
`String`	`getDiskId()`
`Boolean`	`getInstantAccess()`
`Integer`	`getInstantAccessRetentionDays()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`String`	`getResourceGroupId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`Integer`	`getRetentionDays()`
`String`	`getSnapshotName()`
`String`	`getStorageLocationArn()`
`List<CreateSnapshotRequest.CreateSnapshotRequestTag>`	`getTag()`
`CreateSnapshotRequest`	`setCategory(String category)`
`CreateSnapshotRequest`	`setClientToken(String clientToken)`
`CreateSnapshotRequest`	`setDescription(String description)`
`CreateSnapshotRequest`	`setDiskId(String diskId)`
`CreateSnapshotRequest`	`setInstantAccess(Boolean instantAccess)`
`CreateSnapshotRequest`	`setInstantAccessRetentionDays(Integer instantAccessRetentionDays)`
`CreateSnapshotRequest`	`setOwnerAccount(String ownerAccount)`
`CreateSnapshotRequest`	`setOwnerId(Long ownerId)`
`CreateSnapshotRequest`	`setResourceGroupId(String resourceGroupId)`
`CreateSnapshotRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`CreateSnapshotRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`CreateSnapshotRequest`	`setRetentionDays(Integer retentionDays)`
`CreateSnapshotRequest`	`setSnapshotName(String snapshotName)`
`CreateSnapshotRequest`	`setStorageLocationArn(String storageLocationArn)`
`CreateSnapshotRequest`	`setTag(List<CreateSnapshotRequest.CreateSnapshotRequestTag> 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

- 字段详细资料
  - category
```
@NameInMap(value="Category")
public String category
```
    The category of the snapshot. Valid values:
    
    * Standard: regular snapshot
    
    * Flash: local snapshot
    
    > This parameter will be removed in the future. We recommend that you use the `InstantAccess` parameter to ensure future compatibility. This parameter and the `InstantAccess` parameter cannot be specified at the same time. For more information, see the "Description" section of this topic.
  - 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 value, but you must ensure that it is unique among different requests. **The token can only contain ASCII characters and cannot exceed 64 characters in length.** For more information, see [How to ensure idempotence](~~25693~~).
  - description
```
@NameInMap(value="Description")
public String description
```
    The description of the snapshot. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.
    
    By default, this parameter is left empty.
  - diskId
```
@NameInMap(value="DiskId")
public String diskId
```
    The ID of the disk.
  - instantAccess
```
@NameInMap(value="InstantAccess")
public Boolean instantAccess
```
    Specifies whether to enable the instant access feature. Valid values:
    
    * true: enables the instant access feature. The feature can be enabled only for enhanced SSDs (ESSDs).
    
    **
    
    **Note** After the instant access feature is enabled, an instant access snapshot is created and can be used to roll back disks or create disks across zones even if the snapshot is being created. The feature ensures that a new snapshot of an ESSD becomes available for use within 5 seconds regardless of the ESSD size.
    
    * false: disables the instant access feature. In this case, regular snapshots are created.
    
    Default value: false.
    
    > This parameter and the `Category` parameter cannot be specified at the same time. For more information, see the "Description" section of this topic.
  - instantAccessRetentionDays
```
@NameInMap(value="InstantAccessRetentionDays")
public Integer instantAccessRetentionDays
```
    The validity period of the instant access feature. When the validity period ends, the feature is disabled and the instant access snapshot is automatically released. This parameter takes effect only if you set the `InstantAccess` parameter to true. Unit: days. Valid values: 1 to 65535.
    
    By default, the value of this parameter is the same as the value of the `RetentionDays` parameter.
  - ownerAccount
```
@NameInMap(value="OwnerAccount")
public String ownerAccount
```
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - resourceGroupId
```
@NameInMap(value="ResourceGroupId")
public String resourceGroupId
```
    The ID of the resource group to which you want to assign the snapshot.
  - resourceOwnerAccount
```
@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount
```
  - resourceOwnerId
```
@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId
```
  - retentionDays
```
@NameInMap(value="RetentionDays")
public Integer retentionDays
```
    The retention period of the snapshot. Valid values: 1 to 65536. Unit: days. The snapshot is automatically released when its retention period expires.
    
    By default, this parameter is left empty, which specifies that the snapshot is not automatically released.
  - snapshotName
```
@NameInMap(value="SnapshotName")
public String snapshotName
```
    The name of the snapshot. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\_), and hyphens (-).
    
    The name cannot start with `auto` because snapshots whose names start with auto are recognized as automatic snapshots.
  - storageLocationArn
```
@NameInMap(value="StorageLocationArn")
public String storageLocationArn
```
    > This parameter is unavailable.
  - tag
```
@NameInMap(value="Tag")
public List<CreateSnapshotRequest.CreateSnapshotRequestTag> tag
```
    The tags that you want to add to the snapshot.
- 构造器详细资料
  - CreateSnapshotRequest
```
public CreateSnapshotRequest()
```
- 方法详细资料
  - build
```
public static CreateSnapshotRequest build(Map<String,?> map)
                                   throws Exception
```
    抛出:
    
    Exception
  - setCategory
```
public CreateSnapshotRequest setCategory(String category)
```
  - getCategory
```
public String getCategory()
```
  - setClientToken
```
public CreateSnapshotRequest setClientToken(String clientToken)
```
  - getClientToken
```
public String getClientToken()
```
  - setDescription
```
public CreateSnapshotRequest setDescription(String description)
```
  - getDescription
```
public String getDescription()
```
  - setDiskId
```
public CreateSnapshotRequest setDiskId(String diskId)
```
  - getDiskId
```
public String getDiskId()
```
  - setInstantAccess
```
public CreateSnapshotRequest setInstantAccess(Boolean instantAccess)
```
  - getInstantAccess
```
public Boolean getInstantAccess()
```
  - setInstantAccessRetentionDays
```
public CreateSnapshotRequest setInstantAccessRetentionDays(Integer instantAccessRetentionDays)
```
  - getInstantAccessRetentionDays
```
public Integer getInstantAccessRetentionDays()
```
  - setOwnerAccount
```
public CreateSnapshotRequest setOwnerAccount(String ownerAccount)
```
  - getOwnerAccount
```
public String getOwnerAccount()
```
  - setOwnerId
```
public CreateSnapshotRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setResourceGroupId
```
public CreateSnapshotRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setResourceOwnerAccount
```
public CreateSnapshotRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public CreateSnapshotRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setRetentionDays
```
public CreateSnapshotRequest setRetentionDays(Integer retentionDays)
```
  - getRetentionDays
```
public Integer getRetentionDays()
```
  - setSnapshotName
```
public CreateSnapshotRequest setSnapshotName(String snapshotName)
```
  - getSnapshotName
```
public String getSnapshotName()
```
  - setStorageLocationArn
```
public CreateSnapshotRequest setStorageLocationArn(String storageLocationArn)
```
  - getStorageLocationArn
```
public String getStorageLocationArn()
```
  - setTag
```
public CreateSnapshotRequest setTag(List<CreateSnapshotRequest.CreateSnapshotRequestTag> tag)
```
  - getTag
```
public List<CreateSnapshotRequest.CreateSnapshotRequestTag> getTag()
```

类 CreateSnapshotRequest

嵌套类概要

字段概要

构造器概要

方法概要

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

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

字段详细资料

category

clientToken

description

diskId

instantAccess

instantAccessRetentionDays

ownerAccount

ownerId

resourceGroupId

resourceOwnerAccount

resourceOwnerId

retentionDays

snapshotName

storageLocationArn

tag

构造器详细资料

CreateSnapshotRequest

方法详细资料

build

setCategory

getCategory

setClientToken

getClientToken

setDescription

getDescription

setDiskId

getDiskId

setInstantAccess

getInstantAccess

setInstantAccessRetentionDays

getInstantAccessRetentionDays

setOwnerAccount

getOwnerAccount

setOwnerId

getOwnerId

setResourceGroupId

getResourceGroupId

setResourceOwnerAccount

getResourceOwnerAccount

setResourceOwnerId

getResourceOwnerId

setRetentionDays

getRetentionDays

setSnapshotName

getSnapshotName

setStorageLocationArn

getStorageLocationArn

setTag

getTag