com.tencentcloudapi.ecm.v20190719.models

Class DescribeSnapshotsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ecm.v20190719.models.DescribeSnapshotsRequest

public class DescribeSnapshotsRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
DescribeSnapshotsRequest()
DescribeSnapshotsRequest(DescribeSnapshotsRequest 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

Modifier and Type	Method and Description
Filter[]	getFilters() Get Filter.
Long	getLimit() Get Number of returned results.
Long	getOffset() Get Offset.
String	getOrder() Get Sorting order of cloud disks.
String	getOrderField() Get Field by which snapshots are sorted.
String[]	getSnapshotIds() Get List of IDs of the snapshots to be queried.
void	setFilters(Filter[] Filters) Set Filter.
void	setLimit(Long Limit) Set Number of returned results.
void	setOffset(Long Offset) Set Offset.
void	setOrder(String Order) Set Sorting order of cloud disks.
void	setOrderField(String OrderField) Set Field by which snapshots are sorted.
void	setSnapshotIds(String[] SnapshotIds) Set List of IDs of the snapshots to be queried.
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DescribeSnapshotsRequest

public DescribeSnapshotsRequest()

DescribeSnapshotsRequest

public DescribeSnapshotsRequest(DescribeSnapshotsRequest 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

getSnapshotIds

public String[] getSnapshotIds()

Get List of IDs of the snapshots to be queried. `SnapshotIds` and `Filters` cannot be specified at the same time.

Returns:

SnapshotIds List of IDs of the snapshots to be queried. `SnapshotIds` and `Filters` cannot be specified at the same time.

setSnapshotIds

public void setSnapshotIds(String[] SnapshotIds)

Set List of IDs of the snapshots to be queried. `SnapshotIds` and `Filters` cannot be specified at the same time.

Parameters:

SnapshotIds - List of IDs of the snapshots to be queried. `SnapshotIds` and `Filters` cannot be specified at the same time.

getFilters

public Filter[] getFilters()

Get Filter. `SnapshotIds` and `Filters` cannot be specified at the same time.

snapshot-id - Array of String - Required: no - (Filter) Filter by snapshot ID, such as `snap-11112222`.
snapshot-name - Array of String - Required: no - (Filter) Filter by snapshot name.
snapshot-state - Array of String - Required: no - (Filter) Filter by snapshot status. NORMAL: normal; CREATING: creating; ROLLBACKING: rolling back.
disk-usage - Array of String - Required: no - (Filter) Filter by the type of the cloud disk from which a snapshot is created. SYSTEM_DISK: system disk; DATA_DISK: data disk.
project-id - Array of String - Required: no - (Filter) Filter by the project ID of the cloud disk.
disk-id - Array of String - Required: no - (Filter) Filter by the ID of the cloud disk from which a snapshot is created.
zone - Array of String - Required: no - (Filter) Filter by [AZ](https://intl.cloud.tencent.com/document/product/213/15753?from_cn_redirect=1#ZoneInfo).
encrypt - Array of String - Required: no - (Filter) Filter by whether a snapshot is created from an encrypted cloud disk. TRUE: yes; FALSE: no. snapshot-type- Array of String - Required: no - (Filter) Filter by the snapshot type specified in `snapshot-type`. (SHARED_SNAPSHOT: shared snapshot | PRIVATE_SNAPSHOT: private snapshot.)

Returns:

Filters Filter. `SnapshotIds` and `Filters` cannot be specified at the same time.

snapshot-id - Array of String - Required: no - (Filter) Filter by snapshot ID, such as `snap-11112222`.

snapshot-name - Array of String - Required: no - (Filter) Filter by snapshot name.

snapshot-state - Array of String - Required: no - (Filter) Filter by snapshot status. NORMAL: normal; CREATING: creating; ROLLBACKING: rolling back.

disk-usage - Array of String - Required: no - (Filter) Filter by the type of the cloud disk from which a snapshot is created. SYSTEM_DISK: system disk; DATA_DISK: data disk.

project-id - Array of String - Required: no - (Filter) Filter by the project ID of the cloud disk.

disk-id - Array of String - Required: no - (Filter) Filter by the ID of the cloud disk from which a snapshot is created.

zone - Array of String - Required: no - (Filter) Filter by [AZ](https://intl.cloud.tencent.com/document/product/213/15753?from_cn_redirect=1#ZoneInfo).

encrypt - Array of String - Required: no - (Filter) Filter by whether a snapshot is created from an encrypted cloud disk. TRUE: yes; FALSE: no.

snapshot-type- Array of String - Required: no - (Filter) Filter by the snapshot type specified in `snapshot-type`. (SHARED_SNAPSHOT: shared snapshot | PRIVATE_SNAPSHOT: private snapshot.)

setFilters

public void setFilters(Filter[] Filters)

Set Filter. `SnapshotIds` and `Filters` cannot be specified at the same time.

snapshot-id - Array of String - Required: no - (Filter) Filter by snapshot ID, such as `snap-11112222`.
snapshot-name - Array of String - Required: no - (Filter) Filter by snapshot name.
snapshot-state - Array of String - Required: no - (Filter) Filter by snapshot status. NORMAL: normal; CREATING: creating; ROLLBACKING: rolling back.
disk-usage - Array of String - Required: no - (Filter) Filter by the type of the cloud disk from which a snapshot is created. SYSTEM_DISK: system disk; DATA_DISK: data disk.
project-id - Array of String - Required: no - (Filter) Filter by the project ID of the cloud disk.
disk-id - Array of String - Required: no - (Filter) Filter by the ID of the cloud disk from which a snapshot is created.
zone - Array of String - Required: no - (Filter) Filter by [AZ](https://intl.cloud.tencent.com/document/product/213/15753?from_cn_redirect=1#ZoneInfo).
encrypt - Array of String - Required: no - (Filter) Filter by whether a snapshot is created from an encrypted cloud disk. TRUE: yes; FALSE: no. snapshot-type- Array of String - Required: no - (Filter) Filter by the snapshot type specified in `snapshot-type`. (SHARED_SNAPSHOT: shared snapshot | PRIVATE_SNAPSHOT: private snapshot.)