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

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

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 Filters.
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 Filters.
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, 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

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 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 Filters. It cannot be specified together with `SnapshotIds`.

snapshot-id - Array of String - Optional - Filters by snapshot ID, such as `snap-11112222`.
snapshot-name - Array of String - Optional - Filters by snapshot name.
snapshot-state - Array of String - Optional - Filters by snapshot state (NORMAL: normal | CREATING: creating | ROLLBACKING: rolling back).
disk-usage - Array of String - Optional - Filters 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 - Optional - Filters by the ID of the project to which a cloud disk belongs.
disk-id - Array of String - Optional - Filters by the ID of the cloud disk from which a snapshot is created.
zone - Array of String - Optional - Filters by [availability zone](https://intl.cloud.tencent.com/document/product/213/15753?from_cn_redirect=1#ZoneInfo).
encrypt - Array of String - Optional - Filters by whether a snapshot is created from an encrypted cloud disk. (TRUE: a snapshot of an encrypted cloud disk | FALSE: not a snapshot of an encrypted cloud disk.) snapshot-type- Array of String - Optional - Filters by the snapshot type specified in `snapshot-type`. (SHARED_SNAPSHOT: a shared snapshot | PRIVATE_SNAPSHOT: a private snapshot.)

Returns:

Filters Filters. It cannot be specified together with `SnapshotIds`.

snapshot-id - Array of String - Optional - Filters by snapshot ID, such as `snap-11112222`.

snapshot-name - Array of String - Optional - Filters by snapshot name.

snapshot-state - Array of String - Optional - Filters by snapshot state (NORMAL: normal | CREATING: creating | ROLLBACKING: rolling back).

disk-usage - Array of String - Optional - Filters 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 - Optional - Filters by the ID of the project to which a cloud disk belongs.

disk-id - Array of String - Optional - Filters by the ID of the cloud disk from which a snapshot is created.

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

encrypt - Array of String - Optional - Filters by whether a snapshot is created from an encrypted cloud disk. (TRUE: a snapshot of an encrypted cloud disk | FALSE: not a snapshot of an encrypted cloud disk.)

snapshot-type- Array of String - Optional - Filters by the snapshot type specified in `snapshot-type`. (SHARED_SNAPSHOT: a shared snapshot | PRIVATE_SNAPSHOT: a private snapshot.)

setFilters

public void setFilters(Filter[] Filters)

Set Filters. It cannot be specified together with `SnapshotIds`.

snapshot-id - Array of String - Optional - Filters by snapshot ID, such as `snap-11112222`.
snapshot-name - Array of String - Optional - Filters by snapshot name.
snapshot-state - Array of String - Optional - Filters by snapshot state (NORMAL: normal | CREATING: creating | ROLLBACKING: rolling back).
disk-usage - Array of String - Optional - Filters 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 - Optional - Filters by the ID of the project to which a cloud disk belongs.
disk-id - Array of String - Optional - Filters by the ID of the cloud disk from which a snapshot is created.
zone - Array of String - Optional - Filters by [availability zone](https://intl.cloud.tencent.com/document/product/213/15753?from_cn_redirect=1#ZoneInfo).
encrypt - Array of String - Optional - Filters by whether a snapshot is created from an encrypted cloud disk. (TRUE: a snapshot of an encrypted cloud disk | FALSE: not a snapshot of an encrypted cloud disk.) snapshot-type- Array of String - Optional - Filters by the snapshot type specified in `snapshot-type`. (SHARED_SNAPSHOT: a shared snapshot | PRIVATE_SNAPSHOT: a private snapshot.)