Snapshot (tencentcloud-sdk-java 3.1.1355 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.cbs.v20170312.models.Snapshot

public class Snapshot
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor and Description
`Snapshot()`
`Snapshot(Snapshot source)` NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getCopyFromRemote()` Get 是否为跨地域复制的快照。取值范围： true：表示为跨地域复制的快照。 false：本地域的快照。
`String[]`	`getCopyingToRegions()` Get 快照正在跨地域复制的目的地域，若没有则返回`[]`。
`String`	`getCreateTime()` Get 快照的创建时间。
`String`	`getDeadlineTime()` Get 快照到期时间。如果快照为永久保留，此字段为空。
`String`	`getDiskId()` Get 创建此快照的云硬盘ID。
`Long`	`getDiskSize()` Get 创建此快照的云硬盘大小，单位GiB。
`String`	`getDiskUsage()` Get 创建此快照的云硬盘类型。取值范围： SYSTEM_DISK：系统盘 DATA_DISK：数据盘
`Boolean`	`getEncrypt()` Get 是否为加密盘创建的快照。取值范围： true：该快照为加密盘创建的 false：非加密盘创建的快照
`Long`	`getImageCount()` Get 快照关联的镜像个数。
`Image[]`	`getImages()` Get 快照关联的镜像列表。
`Boolean`	`getIsPermanent()` Get 是否为永久快照。取值范围： true：永久快照 false：非永久快照
`Long`	`getPercent()` Get 快照创建进度百分比，快照创建成功后此字段恒为100。
`Placement`	`getPlacement()` Get 快照所在的位置。
`Long`	`getShareReference()` Get 快照当前被共享数。
`String`	`getSnapshotId()` Get 快照ID。
`String`	`getSnapshotName()` Get 快照名称，用户自定义的快照别名。调用[ModifySnapshotAttribute](/document/product/362/15650)可修改此字段。
`String`	`getSnapshotState()` Get 快照的状态。取值范围： NORMAL：正常 CREATING：创建中 ROLLBACKING：回滚中 COPYING_FROM_REMOTE：跨地域复制中 CHECKING_COPIED：复制校验中 TORECYCLE：待回收
`String`	`getSnapshotType()` Get 快照类型，目前该项取值可以为`PRIVATE_SNAPSHOT`（私有快照）或者`SHARED_SNAPSHOT`（共享快照）
`Tag[]`	`getTags()` Get 快照绑定的标签列表。
`String`	`getTimeStartShare()` Get 快照开始共享的时间。
`void`	`setCopyFromRemote(Boolean CopyFromRemote)` Set 是否为跨地域复制的快照。取值范围： true：表示为跨地域复制的快照。 false：本地域的快照。
`void`	`setCopyingToRegions(String[] CopyingToRegions)` Set 快照正在跨地域复制的目的地域，若没有则返回`[]`。
`void`	`setCreateTime(String CreateTime)` Set 快照的创建时间。
`void`	`setDeadlineTime(String DeadlineTime)` Set 快照到期时间。如果快照为永久保留，此字段为空。
`void`	`setDiskId(String DiskId)` Set 创建此快照的云硬盘ID。
`void`	`setDiskSize(Long DiskSize)` Set 创建此快照的云硬盘大小，单位GiB。
`void`	`setDiskUsage(String DiskUsage)` Set 创建此快照的云硬盘类型。取值范围： SYSTEM_DISK：系统盘 DATA_DISK：数据盘
`void`	`setEncrypt(Boolean Encrypt)` Set 是否为加密盘创建的快照。取值范围： true：该快照为加密盘创建的 false：非加密盘创建的快照
`void`	`setImageCount(Long ImageCount)` Set 快照关联的镜像个数。
`void`	`setImages(Image[] Images)` Set 快照关联的镜像列表。
`void`	`setIsPermanent(Boolean IsPermanent)` Set 是否为永久快照。取值范围： true：永久快照 false：非永久快照
`void`	`setPercent(Long Percent)` Set 快照创建进度百分比，快照创建成功后此字段恒为100。
`void`	`setPlacement(Placement Placement)` Set 快照所在的位置。
`void`	`setShareReference(Long ShareReference)` Set 快照当前被共享数。
`void`	`setSnapshotId(String SnapshotId)` Set 快照ID。
`void`	`setSnapshotName(String SnapshotName)` Set 快照名称，用户自定义的快照别名。调用[ModifySnapshotAttribute](/document/product/362/15650)可修改此字段。
`void`	`setSnapshotState(String SnapshotState)` Set 快照的状态。取值范围： NORMAL：正常 CREATING：创建中 ROLLBACKING：回滚中 COPYING_FROM_REMOTE：跨地域复制中 CHECKING_COPIED：复制校验中 TORECYCLE：待回收
`void`	`setSnapshotType(String SnapshotType)` Set 快照类型，目前该项取值可以为`PRIVATE_SNAPSHOT`（私有快照）或者`SHARED_SNAPSHOT`（共享快照）
`void`	`setTags(Tag[] Tags)` Set 快照绑定的标签列表。
`void`	`setTimeStartShare(String TimeStartShare)` Set 快照开始共享的时间。
`void`	`toMap(HashMap<String,String> map, String prefix)` Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Snapshot
```
public Snapshot()
```
  - Snapshot
```
public Snapshot(Snapshot source)
```
    NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
- Method Detail
  - getPlacement
```
public Placement getPlacement()
```
    Get 快照所在的位置。
    
    Returns:
    
    Placement 快照所在的位置。
  - setPlacement
```
public void setPlacement(Placement Placement)
```
    Set 快照所在的位置。
    
    Parameters:
    
    Placement - 快照所在的位置。
  - getCopyFromRemote
```
public Boolean getCopyFromRemote()
```
    Get 是否为跨地域复制的快照。取值范围：
    - true：表示为跨地域复制的快照。
    - false：本地域的快照。
    Returns:
    CopyFromRemote 是否为跨地域复制的快照。取值范围：
    
    true：表示为跨地域复制的快照。
    
    false：本地域的快照。
  - setCopyFromRemote
```
public void setCopyFromRemote(Boolean CopyFromRemote)
```
    Set 是否为跨地域复制的快照。取值范围：
    - true：表示为跨地域复制的快照。
    - false：本地域的快照。
    Parameters:
    CopyFromRemote - 是否为跨地域复制的快照。取值范围：
    
    true：表示为跨地域复制的快照。
    
    false：本地域的快照。
  - getSnapshotState
```
public String getSnapshotState()
```
    Get 快照的状态。取值范围：
    - NORMAL：正常
    - CREATING：创建中
    - ROLLBACKING：回滚中
    - COPYING_FROM_REMOTE：跨地域复制中
    - CHECKING_COPIED：复制校验中
    - TORECYCLE：待回收
    Returns:
    SnapshotState 快照的状态。取值范围：
    
    NORMAL：正常
    
    CREATING：创建中
    
    ROLLBACKING：回滚中
    
    COPYING_FROM_REMOTE：跨地域复制中
    
    CHECKING_COPIED：复制校验中
    
    TORECYCLE：待回收
  - setSnapshotState
```
public void setSnapshotState(String SnapshotState)
```
    Set 快照的状态。取值范围：
    - NORMAL：正常
    - CREATING：创建中
    - ROLLBACKING：回滚中
    - COPYING_FROM_REMOTE：跨地域复制中
    - CHECKING_COPIED：复制校验中
    - TORECYCLE：待回收
    Parameters:
    SnapshotState - 快照的状态。取值范围：
    
    NORMAL：正常
    
    CREATING：创建中
    
    ROLLBACKING：回滚中
    
    COPYING_FROM_REMOTE：跨地域复制中
    
    CHECKING_COPIED：复制校验中
    
    TORECYCLE：待回收
  - getIsPermanent
```
public Boolean getIsPermanent()
```
    Get 是否为永久快照。取值范围：
    - true：永久快照
    - false：非永久快照
    Returns:
    IsPermanent 是否为永久快照。取值范围：
    
    true：永久快照
    
    false：非永久快照
  - setIsPermanent
```
public void setIsPermanent(Boolean IsPermanent)
```
    Set 是否为永久快照。取值范围：
    - true：永久快照
    - false：非永久快照
    Parameters:
    IsPermanent - 是否为永久快照。取值范围：
    
    true：永久快照
    
    false：非永久快照
  - getSnapshotName
```
public String getSnapshotName()
```
    Get 快照名称，用户自定义的快照别名。调用[ModifySnapshotAttribute](/document/product/362/15650)可修改此字段。
    
    Returns:
    
    SnapshotName 快照名称，用户自定义的快照别名。调用[ModifySnapshotAttribute](/document/product/362/15650)可修改此字段。
  - setSnapshotName
```
public void setSnapshotName(String SnapshotName)
```
    Set 快照名称，用户自定义的快照别名。调用[ModifySnapshotAttribute](/document/product/362/15650)可修改此字段。
    
    Parameters:
    
    SnapshotName - 快照名称，用户自定义的快照别名。调用[ModifySnapshotAttribute](/document/product/362/15650)可修改此字段。
  - getDeadlineTime
```
public String getDeadlineTime()
```
    Get 快照到期时间。如果快照为永久保留，此字段为空。
    
    Returns:
    
    DeadlineTime 快照到期时间。如果快照为永久保留，此字段为空。
  - setDeadlineTime
```
public void setDeadlineTime(String DeadlineTime)
```
    Set 快照到期时间。如果快照为永久保留，此字段为空。
    
    Parameters:
    
    DeadlineTime - 快照到期时间。如果快照为永久保留，此字段为空。
  - getPercent
```
public Long getPercent()
```
    Get 快照创建进度百分比，快照创建成功后此字段恒为100。
    
    Returns:
    
    Percent 快照创建进度百分比，快照创建成功后此字段恒为100。
  - setPercent
```
public void setPercent(Long Percent)
```
    Set 快照创建进度百分比，快照创建成功后此字段恒为100。
    
    Parameters:
    
    Percent - 快照创建进度百分比，快照创建成功后此字段恒为100。
  - getImages
```
public Image[] getImages()
```
    Get 快照关联的镜像列表。
    
    Returns:
    
    Images 快照关联的镜像列表。
  - setImages
```
public void setImages(Image[] Images)
```
    Set 快照关联的镜像列表。
    
    Parameters:
    
    Images - 快照关联的镜像列表。
  - getShareReference
```
public Long getShareReference()
```
    Get 快照当前被共享数。
    
    Returns:
    
    ShareReference 快照当前被共享数。
  - setShareReference
```
public void setShareReference(Long ShareReference)
```
    Set 快照当前被共享数。
    
    Parameters:
    
    ShareReference - 快照当前被共享数。
  - getSnapshotType
```
public String getSnapshotType()
```
    Get 快照类型，目前该项取值可以为`PRIVATE_SNAPSHOT`（私有快照）或者`SHARED_SNAPSHOT`（共享快照）
    
    Returns:
    
    SnapshotType 快照类型，目前该项取值可以为`PRIVATE_SNAPSHOT`（私有快照）或者`SHARED_SNAPSHOT`（共享快照）
  - setSnapshotType
```
public void setSnapshotType(String SnapshotType)
```
    Set 快照类型，目前该项取值可以为`PRIVATE_SNAPSHOT`（私有快照）或者`SHARED_SNAPSHOT`（共享快照）
    
    Parameters:
    
    SnapshotType - 快照类型，目前该项取值可以为`PRIVATE_SNAPSHOT`（私有快照）或者`SHARED_SNAPSHOT`（共享快照）
  - getDiskSize
```
public Long getDiskSize()
```
    Get 创建此快照的云硬盘大小，单位GiB。
    
    Returns:
    
    DiskSize 创建此快照的云硬盘大小，单位GiB。
  - setDiskSize
```
public void setDiskSize(Long DiskSize)
```
    Set 创建此快照的云硬盘大小，单位GiB。
    
    Parameters:
    
    DiskSize - 创建此快照的云硬盘大小，单位GiB。
  - getDiskId
```
public String getDiskId()
```
    Get 创建此快照的云硬盘ID。
    
    Returns:
    
    DiskId 创建此快照的云硬盘ID。
  - setDiskId
```
public void setDiskId(String DiskId)
```
    Set 创建此快照的云硬盘ID。
    
    Parameters:
    
    DiskId - 创建此快照的云硬盘ID。
  - getCopyingToRegions
```
public String[] getCopyingToRegions()
```
    Get 快照正在跨地域复制的目的地域，若没有则返回`[]`。
    
    Returns:
    
    CopyingToRegions 快照正在跨地域复制的目的地域，若没有则返回`[]`。
  - setCopyingToRegions
```
public void setCopyingToRegions(String[] CopyingToRegions)
```
    Set 快照正在跨地域复制的目的地域，若没有则返回`[]`。
    
    Parameters:
    
    CopyingToRegions - 快照正在跨地域复制的目的地域，若没有则返回`[]`。
  - getEncrypt
```
public Boolean getEncrypt()
```
    Get 是否为加密盘创建的快照。取值范围：
    - true：该快照为加密盘创建的
    - false：非加密盘创建的快照
    Returns:
    Encrypt 是否为加密盘创建的快照。取值范围：
    
    true：该快照为加密盘创建的
    
    false：非加密盘创建的快照
  - setEncrypt
```
public void setEncrypt(Boolean Encrypt)
```
    Set 是否为加密盘创建的快照。取值范围：
    - true：该快照为加密盘创建的
    - false：非加密盘创建的快照
    Parameters:
    Encrypt - 是否为加密盘创建的快照。取值范围：
    
    true：该快照为加密盘创建的
    
    false：非加密盘创建的快照
  - getCreateTime
```
public String getCreateTime()
```
    Get 快照的创建时间。
    
    Returns:
    
    CreateTime 快照的创建时间。
  - setCreateTime
```
public void setCreateTime(String CreateTime)
```
    Set 快照的创建时间。
    
    Parameters:
    
    CreateTime - 快照的创建时间。
  - getImageCount
```
public Long getImageCount()
```
    Get 快照关联的镜像个数。
    
    Returns:
    
    ImageCount 快照关联的镜像个数。
  - setImageCount
```
public void setImageCount(Long ImageCount)
```
    Set 快照关联的镜像个数。
    
    Parameters:
    
    ImageCount - 快照关联的镜像个数。
  - getDiskUsage
```
public String getDiskUsage()
```
    Get 创建此快照的云硬盘类型。取值范围：
    - SYSTEM_DISK：系统盘
    - DATA_DISK：数据盘
    Returns:
    DiskUsage 创建此快照的云硬盘类型。取值范围：
    
    SYSTEM_DISK：系统盘
    
    DATA_DISK：数据盘
  - setDiskUsage
```
public void setDiskUsage(String DiskUsage)
```
    Set 创建此快照的云硬盘类型。取值范围：
    - SYSTEM_DISK：系统盘
    - DATA_DISK：数据盘
    Parameters:
    DiskUsage - 创建此快照的云硬盘类型。取值范围：
    
    SYSTEM_DISK：系统盘
    
    DATA_DISK：数据盘
  - getSnapshotId
```
public String getSnapshotId()
```
    Get 快照ID。
    
    Returns:
    
    SnapshotId 快照ID。
  - setSnapshotId
```
public void setSnapshotId(String SnapshotId)
```
    Set 快照ID。
    
    Parameters:
    
    SnapshotId - 快照ID。
  - getTimeStartShare
```
public String getTimeStartShare()
```
    Get 快照开始共享的时间。
    
    Returns:
    
    TimeStartShare 快照开始共享的时间。
  - setTimeStartShare
```
public void setTimeStartShare(String TimeStartShare)
```
    Set 快照开始共享的时间。
    
    Parameters:
    
    TimeStartShare - 快照开始共享的时间。
  - getTags
```
public Tag[] getTags()
```
    Get 快照绑定的标签列表。
    
    Returns:
    
    Tags 快照绑定的标签列表。
  - setTags
```
public void setTags(Tag[] Tags)
```
    Set 快照绑定的标签列表。
    
    Parameters:
    
    Tags - 快照绑定的标签列表。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel
    
    Parameters:
    
    map - The map to populate with the model's parameters.
    
    prefix - A string prefix for the keys.

Class Snapshot

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

Snapshot

Snapshot

Method Detail

getPlacement

setPlacement

getCopyFromRemote

setCopyFromRemote

getSnapshotState

setSnapshotState

getIsPermanent

setIsPermanent

getSnapshotName

setSnapshotName

getDeadlineTime

setDeadlineTime

getPercent

setPercent

getImages

setImages

getShareReference

setShareReference

getSnapshotType

setSnapshotType

getDiskSize

setDiskSize

getDiskId

setDiskId

getCopyingToRegions

setCopyingToRegions

getEncrypt

setEncrypt

getCreateTime

setCreateTime

getImageCount

setImageCount

getDiskUsage

setDiskUsage

getSnapshotId

setSnapshotId

getTimeStartShare

setTimeStartShare

getTags

setTags

toMap