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 过滤条件。参数不支持同时指定SnapshotIds和Filters。 snapshot-id按照云硬盘快照ID进行过滤类型：String必选：否snapshot-name按照云硬盘快照名称进行过滤类型：String必选：否snapshot-state按照云硬盘快照状态进行过滤类型：String必选：否取值范围：NORMAL：正常 CREATING：创建中 ROLLBACKING：回滚中 COPYING_FROM_REMOTE：跨地域复制中 CHECKING_COPIED：复制校验中TORECYCLE：待回收disk-usage按照云硬盘使用用途进行过滤类型：String必选：否取值范围：SYSTEM_DISK：代表系统盘DATA_DISK：代表数据盘project-id按云硬盘所属项目ID过滤类型：String必选：否disk-id按照云硬盘ID进行过滤，一次最多只能传入10个值类型：String必选：否encrypt按是否加密进行过滤类型：String必选：否snapshot-type按快照归属类型查询类型：String必选：否取值范围：SHARED_SNAPSHOT：表示共享过来的快照PRIVATE_SNAPSHOT：表示自己的私有快照
Long	getLimit() Get 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。
Long	getOffset() Get 偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。
String	getOrder() Get 输出云盘列表的排列顺序。取值范围： ASC：升序排列 DESC：降序排列。
String	getOrderField() Get 快照列表排序的依据字段。取值范围： CREATE_TIME：依据快照的创建时间排序 默认按创建时间排序
String[]	getSnapshotIds() Get 要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。
void	setFilters(Filter[] Filters) Set 过滤条件。参数不支持同时指定SnapshotIds和Filters。 snapshot-id按照云硬盘快照ID进行过滤类型：String必选：否snapshot-name按照云硬盘快照名称进行过滤类型：String必选：否snapshot-state按照云硬盘快照状态进行过滤类型：String必选：否取值范围：NORMAL：正常 CREATING：创建中 ROLLBACKING：回滚中 COPYING_FROM_REMOTE：跨地域复制中 CHECKING_COPIED：复制校验中TORECYCLE：待回收disk-usage按照云硬盘使用用途进行过滤类型：String必选：否取值范围：SYSTEM_DISK：代表系统盘DATA_DISK：代表数据盘project-id按云硬盘所属项目ID过滤类型：String必选：否disk-id按照云硬盘ID进行过滤，一次最多只能传入10个值类型：String必选：否encrypt按是否加密进行过滤类型：String必选：否snapshot-type按快照归属类型查询类型：String必选：否取值范围：SHARED_SNAPSHOT：表示共享过来的快照PRIVATE_SNAPSHOT：表示自己的私有快照
void	setLimit(Long Limit) Set 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。
void	setOffset(Long Offset) Set 偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。
void	setOrder(String Order) Set 输出云盘列表的排列顺序。取值范围： ASC：升序排列 DESC：降序排列。
void	setOrderField(String OrderField) Set 快照列表排序的依据字段。取值范围： CREATE_TIME：依据快照的创建时间排序 默认按创建时间排序
void	setSnapshotIds(String[] SnapshotIds) Set 要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。
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 要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。

Returns:

SnapshotIds 要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。

setSnapshotIds

public void setSnapshotIds(String[] SnapshotIds)

Set 要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。

Parameters:

SnapshotIds - 要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。

getFilters

public Filter[] getFilters()

Get 过滤条件。参数不支持同时指定SnapshotIds和Filters。

• snapshot-id
  • 按照云硬盘快照ID进行过滤
  • 类型：String
  • 必选：否
• snapshot-name
  • 按照云硬盘快照名称进行过滤
  • 类型：String
  • 必选：否
• snapshot-state
  • 按照云硬盘快照状态进行过滤
  • 类型：String
  • 必选：否
  • 取值范围：
    • NORMAL：正常
    • CREATING：创建中
    • ROLLBACKING：回滚中
    • COPYING_FROM_REMOTE：跨地域复制中
    • CHECKING_COPIED：复制校验中
    • TORECYCLE：待回收
• disk-usage
  • 按照云硬盘使用用途进行过滤
  • 类型：String
  • 必选：否
  • 取值范围：
    • SYSTEM_DISK：代表系统盘
    • DATA_DISK：代表数据盘
• project-id
  • 按云硬盘所属项目ID过滤
  • 类型：String
  • 必选：否
• disk-id
  • 按照云硬盘ID进行过滤，一次最多只能传入10个值
  • 类型：String
  • 必选：否
• encrypt
  • 按是否加密进行过滤
  • 类型：String
  • 必选：否
• snapshot-type
  • 按快照归属类型查询
  • 类型：String
  • 必选：否
  • 取值范围：
    • SHARED_SNAPSHOT：表示共享过来的快照
    • PRIVATE_SNAPSHOT：表示自己的私有快照

Returns:

Filters 过滤条件。参数不支持同时指定SnapshotIds和Filters。

• snapshot-id
  • 按照云硬盘快照ID进行过滤
  • 类型：String
  • 必选：否
• snapshot-name
  • 按照云硬盘快照名称进行过滤
  • 类型：String
  • 必选：否
• snapshot-state
  • 按照云硬盘快照状态进行过滤
  • 类型：String
  • 必选：否
  • 取值范围：
    • NORMAL：正常
    • CREATING：创建中
    • ROLLBACKING：回滚中
    • COPYING_FROM_REMOTE：跨地域复制中
    • CHECKING_COPIED：复制校验中
    • TORECYCLE：待回收
• disk-usage
  • 按照云硬盘使用用途进行过滤
  • 类型：String
  • 必选：否
  • 取值范围：
    • SYSTEM_DISK：代表系统盘
    • DATA_DISK：代表数据盘
• project-id
  • 按云硬盘所属项目ID过滤
  • 类型：String
  • 必选：否
• disk-id
  • 按照云硬盘ID进行过滤，一次最多只能传入10个值
  • 类型：String
  • 必选：否
• encrypt
  • 按是否加密进行过滤
  • 类型：String
  • 必选：否
• snapshot-type
  • 按快照归属类型查询
  • 类型：String
  • 必选：否
  • 取值范围：
    • SHARED_SNAPSHOT：表示共享过来的快照
    • PRIVATE_SNAPSHOT：表示自己的私有快照

setFilters

public void setFilters(Filter[] Filters)

Set 过滤条件。参数不支持同时指定SnapshotIds和Filters。

• snapshot-id
  • 按照云硬盘快照ID进行过滤
  • 类型：String
  • 必选：否
• snapshot-name
  • 按照云硬盘快照名称进行过滤
  • 类型：String
  • 必选：否
• snapshot-state
  • 按照云硬盘快照状态进行过滤
  • 类型：String
  • 必选：否
  • 取值范围：
    • NORMAL：正常
    • CREATING：创建中
    • ROLLBACKING：回滚中
    • COPYING_FROM_REMOTE：跨地域复制中
    • CHECKING_COPIED：复制校验中
    • TORECYCLE：待回收
• disk-usage
  • 按照云硬盘使用用途进行过滤
  • 类型：String
  • 必选：否
  • 取值范围：
    • SYSTEM_DISK：代表系统盘
    • DATA_DISK：代表数据盘
• project-id
  • 按云硬盘所属项目ID过滤
  • 类型：String
  • 必选：否
• disk-id
  • 按照云硬盘ID进行过滤，一次最多只能传入10个值
  • 类型：String
  • 必选：否
• encrypt
  • 按是否加密进行过滤
  • 类型：String
  • 必选：否
• snapshot-type
  • 按快照归属类型查询
  • 类型：String
  • 必选：否
  • 取值范围：
    • SHARED_SNAPSHOT：表示共享过来的快照
    • PRIVATE_SNAPSHOT：表示自己的私有快照

Parameters:

Filters - 过滤条件。参数不支持同时指定SnapshotIds和Filters。

• snapshot-id
  • 按照云硬盘快照ID进行过滤
  • 类型：String
  • 必选：否
• snapshot-name
  • 按照云硬盘快照名称进行过滤
  • 类型：String
  • 必选：否
• snapshot-state
  • 按照云硬盘快照状态进行过滤
  • 类型：String
  • 必选：否
  • 取值范围：
    • NORMAL：正常
    • CREATING：创建中
    • ROLLBACKING：回滚中
    • COPYING_FROM_REMOTE：跨地域复制中
    • CHECKING_COPIED：复制校验中
    • TORECYCLE：待回收
• disk-usage
  • 按照云硬盘使用用途进行过滤
  • 类型：String
  • 必选：否
  • 取值范围：
    • SYSTEM_DISK：代表系统盘
    • DATA_DISK：代表数据盘
• project-id
  • 按云硬盘所属项目ID过滤
  • 类型：String
  • 必选：否
• disk-id
  • 按照云硬盘ID进行过滤，一次最多只能传入10个值
  • 类型：String
  • 必选：否
• encrypt
  • 按是否加密进行过滤
  • 类型：String
  • 必选：否
• snapshot-type
  • 按快照归属类型查询
  • 类型：String
  • 必选：否
  • 取值范围：
    • SHARED_SNAPSHOT：表示共享过来的快照
    • PRIVATE_SNAPSHOT：表示自己的私有快照

getLimit

public Long getLimit()

Get 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。

Returns:

Limit 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。

setLimit

public void setLimit(Long Limit)

Set 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。

Parameters:

Limit - 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。

getOrderField

public String getOrderField()

Get 快照列表排序的依据字段。取值范围：

• CREATE_TIME：依据快照的创建时间排序
• 默认按创建时间排序

Returns:

OrderField 快照列表排序的依据字段。取值范围：

• CREATE_TIME：依据快照的创建时间排序
• 默认按创建时间排序

setOrderField

public void setOrderField(String OrderField)

Set 快照列表排序的依据字段。取值范围：

• CREATE_TIME：依据快照的创建时间排序
• 默认按创建时间排序

Parameters:

OrderField - 快照列表排序的依据字段。取值范围：

• CREATE_TIME：依据快照的创建时间排序
• 默认按创建时间排序

getOffset

public Long getOffset()

Get 偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。

Returns:

Offset 偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。

setOffset

public void setOffset(Long Offset)

Set 偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。

Parameters:

Offset - 偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。

getOrder

public String getOrder()

Get 输出云盘列表的排列顺序。取值范围：

• ASC：升序排列
• DESC：降序排列。

Returns:

Order 输出云盘列表的排列顺序。取值范围：

• ASC：升序排列
• DESC：降序排列。

setOrder

public void setOrder(String Order)

Set 输出云盘列表的排列顺序。取值范围：

• ASC：升序排列
• DESC：降序排列。

Parameters:

Order - 输出云盘列表的排列顺序。取值范围：

• ASC：升序排列
• DESC：降序排列。

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.