com.tencentcloudapi.cbs.v20170312.models

Class DescribeSnapshotsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cbs.v20170312.models.DescribeSnapshotsRequest

public class DescribeSnapshotsRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
DescribeSnapshotsRequest()

Method Summary

Modifier and Type	Method and Description
Filter[]	getFilters() Get Filter conditions.
Long	getLimit() Get Number of results to be returned.
Long	getOffset() Get Offset.
String	getOrder() Get Outputs the ordering of the cloud disk list.
String	getOrderField() Get The field by which the snapshot list is sorted.
String[]	getSnapshotIds() Get List of snapshot IDs to be queried.
void	setFilters(Filter[] Filters) Set Filter conditions.
void	setLimit(Long Limit) Set Number of results to be returned.
void	setOffset(Long Offset) Set Offset.
void	setOrder(String Order) Set Outputs the ordering of the cloud disk list.
void	setOrderField(String OrderField) Set The field by which the snapshot list is sorted.
void	setSnapshotIds(String[] SnapshotIds) Set List of snapshot IDs 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()

Method Detail

getSnapshotIds

public String[] getSnapshotIds()

Get List of snapshot IDs to be queried. The parameter does not support specifying both `SnapshotIds` and `Filters`.

Returns:

SnapshotIds List of snapshot IDs to be queried. The parameter does not support specifying both `SnapshotIds` and `Filters`.

setSnapshotIds

public void setSnapshotIds(String[] SnapshotIds)

Set List of snapshot IDs to be queried. The parameter does not support specifying both `SnapshotIds` and `Filters`.

Parameters:

SnapshotIds - List of snapshot IDs to be queried. The parameter does not support specifying both `SnapshotIds` and `Filters`.

getFilters

public Filter[] getFilters()

Get Filter conditions. The specification of both the `SnapshotIds` and `Filters` parameters is not supported.

snapshot-id - Array of String - Required or not: No - (Filter condition) Filter by the snapshot ID. The format of the snapshot ID is as follows: `snap-11112222`.
snapshot-name - Array of String - Required or not: No - (Filter condition) Filter by the snapshot name.
snapshot-state - Array of String - Required or not: No - (Filter condition) Filter by the snapshot status (NORMAL: normal | CREATING: creating | ROLLBACKING: rolling back).
disk-usage - Array of String - Required or not: No - (Filter condition) Filter by the type of the cloud disk for which the snapshot is created (SYSTEM_DISK: system disk | DATA_DISK: data disk).
project-id - Array of String - Required or not: No - (Filter condition) Filter by ID of the project to which the cloud disk belongs.
disk-id - Array of String - Required or not: No - (Filter condition) Filter by the ID of the cloud disk for which the snapshot is created.
zone - Array of String - Required or not: No - (Filter condition) Filter by [Availability Zone](/document/product/213/15753#ZoneInfo).
encrypt - Array of String - Required or not: No - (Filter condition) According to whether it is an encrypted disk snapshot. (TRUE: indicates an encrypted disk snapshot | FALSE: indicates that it is not an encrypted disk snapshot.)

Returns:

Filters Filter conditions. The specification of both the `SnapshotIds` and `Filters` parameters is not supported.

snapshot-id - Array of String - Required or not: No - (Filter condition) Filter by the snapshot ID. The format of the snapshot ID is as follows: `snap-11112222`.

snapshot-name - Array of String - Required or not: No - (Filter condition) Filter by the snapshot name.

snapshot-state - Array of String - Required or not: No - (Filter condition) Filter by the snapshot status (NORMAL: normal | CREATING: creating | ROLLBACKING: rolling back).

disk-usage - Array of String - Required or not: No - (Filter condition) Filter by the type of the cloud disk for which the snapshot is created (SYSTEM_DISK: system disk | DATA_DISK: data disk).

project-id - Array of String - Required or not: No - (Filter condition) Filter by ID of the project to which the cloud disk belongs.

disk-id - Array of String - Required or not: No - (Filter condition) Filter by the ID of the cloud disk for which the snapshot is created.

zone - Array of String - Required or not: No - (Filter condition) Filter by [Availability Zone](/document/product/213/15753#ZoneInfo).

encrypt - Array of String - Required or not: No - (Filter condition) According to whether it is an encrypted disk snapshot. (TRUE: indicates an encrypted disk snapshot | FALSE: indicates that it is not an encrypted disk snapshot.)

setFilters

public void setFilters(Filter[] Filters)

Set Filter conditions. The specification of both the `SnapshotIds` and `Filters` parameters is not supported.

snapshot-id - Array of String - Required or not: No - (Filter condition) Filter by the snapshot ID. The format of the snapshot ID is as follows: `snap-11112222`.
snapshot-name - Array of String - Required or not: No - (Filter condition) Filter by the snapshot name.
snapshot-state - Array of String - Required or not: No - (Filter condition) Filter by the snapshot status (NORMAL: normal | CREATING: creating | ROLLBACKING: rolling back).
disk-usage - Array of String - Required or not: No - (Filter condition) Filter by the type of the cloud disk for which the snapshot is created (SYSTEM_DISK: system disk | DATA_DISK: data disk).
project-id - Array of String - Required or not: No - (Filter condition) Filter by ID of the project to which the cloud disk belongs.
disk-id - Array of String - Required or not: No - (Filter condition) Filter by the ID of the cloud disk for which the snapshot is created.
zone - Array of String - Required or not: No - (Filter condition) Filter by [Availability Zone](/document/product/213/15753#ZoneInfo).
encrypt - Array of String - Required or not: No - (Filter condition) According to whether it is an encrypted disk snapshot. (TRUE: indicates an encrypted disk snapshot | FALSE: indicates that it is not an encrypted disk snapshot.)