public class Snapshot extends AbstractModel
header, skipSign| 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. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Boolean | 
getCopyFromRemote()
Get Whether the snapshot is replicated across regions. 
 | 
String[] | 
getCopyingToRegions()
Get Destination region to which the snapshot is being replicated. 
 | 
String | 
getCreateTime()
Get Snapshot creation time. 
 | 
String | 
getDeadlineTime()
Get Snapshot expiration time. 
 | 
String | 
getDiskId()
Get ID of the cloud disk for which the snapshot is created. 
 | 
Long | 
getDiskSize()
Get Size in GB of the cloud disk for which the snapshot is created. 
 | 
String | 
getDiskUsage()
Get Type of the cloud disk for which the snapshot is created. 
 | 
Boolean | 
getEncrypt()
Get Whether the snapshot is created from an encrypted disk. 
 | 
Long | 
getImageCount()
Get Number of images associated with the snapshot. 
 | 
Image[] | 
getImages()
Get List of images associated with the snapshot. 
 | 
Boolean | 
getIsPermanent()
Get Whether the snapshot is a permanent snapshot. 
 | 
Long | 
getPercent()
Get Snapshot creation progress in percentage. 
 | 
Placement | 
getPlacement()
Get Snapshot location. 
 | 
Long | 
getShareReference()
Get Number of snapshots currently shared. 
 | 
String | 
getSnapshotId()
Get Snapshot ID. 
 | 
String | 
getSnapshotName()
Get Snapshot name, i.e., the user-defined snapshot alias. 
 | 
String | 
getSnapshotState()
Get Snapshot status. 
 | 
String | 
getSnapshotType()
Get Snapshot type. 
 | 
String | 
getTimeStartShare()
Get Time when snapshot sharing starts. 
 | 
void | 
setCopyFromRemote(Boolean CopyFromRemote)
Set Whether the snapshot is replicated across regions. 
 | 
void | 
setCopyingToRegions(String[] CopyingToRegions)
Set Destination region to which the snapshot is being replicated. 
 | 
void | 
setCreateTime(String CreateTime)
Set Snapshot creation time. 
 | 
void | 
setDeadlineTime(String DeadlineTime)
Set Snapshot expiration time. 
 | 
void | 
setDiskId(String DiskId)
Set ID of the cloud disk for which the snapshot is created. 
 | 
void | 
setDiskSize(Long DiskSize)
Set Size in GB of the cloud disk for which the snapshot is created. 
 | 
void | 
setDiskUsage(String DiskUsage)
Set Type of the cloud disk for which the snapshot is created. 
 | 
void | 
setEncrypt(Boolean Encrypt)
Set Whether the snapshot is created from an encrypted disk. 
 | 
void | 
setImageCount(Long ImageCount)
Set Number of images associated with the snapshot. 
 | 
void | 
setImages(Image[] Images)
Set List of images associated with the snapshot. 
 | 
void | 
setIsPermanent(Boolean IsPermanent)
Set Whether the snapshot is a permanent snapshot. 
 | 
void | 
setPercent(Long Percent)
Set Snapshot creation progress in percentage. 
 | 
void | 
setPlacement(Placement Placement)
Set Snapshot location. 
 | 
void | 
setShareReference(Long ShareReference)
Set Number of snapshots currently shared. 
 | 
void | 
setSnapshotId(String SnapshotId)
Set Snapshot ID. 
 | 
void | 
setSnapshotName(String SnapshotName)
Set Snapshot name, i.e., the user-defined snapshot alias. 
 | 
void | 
setSnapshotState(String SnapshotState)
Set Snapshot status. 
 | 
void | 
setSnapshotType(String SnapshotType)
Set Snapshot type. 
 | 
void | 
setTimeStartShare(String TimeStartShare)
Set Time when snapshot sharing starts. 
 | 
void | 
toMap(HashMap<String,String> map,
     String prefix)
Internal implementation, normal users should not use it. 
 | 
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonStringpublic Snapshot()
public Snapshot(Snapshot source)
public Placement getPlacement()
public void setPlacement(Placement Placement)
Placement - Snapshot location.public Boolean getCopyFromRemote()
public void setCopyFromRemote(Boolean CopyFromRemote)
CopyFromRemote - Whether the snapshot is replicated across regions. Valid values:public Boolean getIsPermanent()
public void setIsPermanent(Boolean IsPermanent)
IsPermanent - Whether the snapshot is a permanent snapshot. Valid values:public String getSnapshotName()
public void setSnapshotName(String SnapshotName)
SnapshotName - Snapshot name, i.e., the user-defined snapshot alias. You can call [ModifySnapshotAttribute](https://intl.cloud.tencent.com/document/product/362/15650?from_cn_redirect=1) to modify this field.public Long getPercent()
public void setPercent(Long Percent)
Percent - Snapshot creation progress in percentage. This field will always be `100` once the snapshot is created successfully.public Image[] getImages()
public void setImages(Image[] Images)
Images - List of images associated with the snapshot.public Long getShareReference()
public void setShareReference(Long ShareReference)
ShareReference - Number of snapshots currently shared.public String getSnapshotType()
public void setSnapshotType(String SnapshotType)
SnapshotType - Snapshot type. Valid values: PRIVATE_SNAPSHOT, SHARED_SNAPSHOTpublic Long getDiskSize()
public void setDiskSize(Long DiskSize)
DiskSize - Size in GB of the cloud disk for which the snapshot is created.public String getDiskId()
public void setDiskId(String DiskId)
DiskId - ID of the cloud disk for which the snapshot is created.public String[] getCopyingToRegions()
public void setCopyingToRegions(String[] CopyingToRegions)
CopyingToRegions - Destination region to which the snapshot is being replicated. Default value: [].public String getSnapshotId()
public void setSnapshotId(String SnapshotId)
SnapshotId - Snapshot ID.public String getDiskUsage()
public void setDiskUsage(String DiskUsage)
DiskUsage - Type of the cloud disk for which the snapshot is created. Valid values:public Boolean getEncrypt()
public void setEncrypt(Boolean Encrypt)
Encrypt - Whether the snapshot is created from an encrypted disk. Valid values:public String getCreateTime()
public void setCreateTime(String CreateTime)
CreateTime - Snapshot creation time.public Long getImageCount()
public void setImageCount(Long ImageCount)
ImageCount - Number of images associated with the snapshot.public String getSnapshotState()
public void setSnapshotState(String SnapshotState)
SnapshotState - Snapshot status. Valid values:public String getDeadlineTime()
public void setDeadlineTime(String DeadlineTime)
DeadlineTime - Snapshot expiration time.public String getTimeStartShare()
public void setTimeStartShare(String TimeStartShare)
TimeStartShare - Time when snapshot sharing starts.
Note: this field may return null, indicating that no valid values can be obtained.Copyright © 2025. All rights reserved.