Package com.tencentcloudapi.cvm.v20170312.models

Class DescribeImagesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cvm.v20170312.models.DescribeImagesRequest

public class DescribeImagesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor	Description
DescribeImagesRequest()
DescribeImagesRequest(DescribeImagesRequest 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	Description
Filter[]	getFilters()	Get 过滤条件，每次请求的`Filters`的上限为10，`Filters.Values`的上限为5。参数不可以同时指定`ImageIds`和`Filters`。详细的过滤条件如下： image-id
String[]	getImageIds()	Get 镜像ID列表 。镜像ID如：`img-gvbnzy6f`。array型参数的格式可以参考[API简介](https://cloud.tencent.com/document/api/213/15688)。镜像ID可以通过如下方式获取： 通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回的`ImageId`获取。 通过[镜像控制台](https://console.cloud.tencent.com/cvm/image)获取。
String	getInstanceType()	Get 实例类型，如 `S1.SMALL1`
Long	getLimit()	Get 数量限制，默认为20，最大值为100。关于Limit详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。
Long	getOffset()	Get 偏移量，默认为0。关于Offset详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。
void	setFilters(Filter[] Filters)	Set 过滤条件，每次请求的`Filters`的上限为10，`Filters.Values`的上限为5。参数不可以同时指定`ImageIds`和`Filters`。详细的过滤条件如下： image-id
void	setImageIds(String[] ImageIds)	Set 镜像ID列表 。镜像ID如：`img-gvbnzy6f`。array型参数的格式可以参考[API简介](https://cloud.tencent.com/document/api/213/15688)。镜像ID可以通过如下方式获取： 通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回的`ImageId`获取。 通过[镜像控制台](https://console.cloud.tencent.com/cvm/image)获取。
void	setInstanceType(String InstanceType)	Set 实例类型，如 `S1.SMALL1`
void	setLimit(Long Limit)	Set 数量限制，默认为20，最大值为100。关于Limit详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。
void	setOffset(Long Offset)	Set 偏移量，默认为0。关于Offset详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。
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, 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

DescribeImagesRequest

public DescribeImagesRequest()

DescribeImagesRequest

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

getImageIds

public String[] getImageIds()

Get 镜像ID列表 。镜像ID如：`img-gvbnzy6f`。array型参数的格式可以参考[API简介](https://cloud.tencent.com/document/api/213/15688)。镜像ID可以通过如下方式获取：

通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回的`ImageId`获取。
通过[镜像控制台](https://console.cloud.tencent.com/cvm/image)获取。

Returns:

ImageIds 镜像ID列表 。镜像ID如：`img-gvbnzy6f`。array型参数的格式可以参考[API简介](https://cloud.tencent.com/document/api/213/15688)。镜像ID可以通过如下方式获取：

通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回的`ImageId`获取。

通过[镜像控制台](https://console.cloud.tencent.com/cvm/image)获取。

setImageIds

public void setImageIds(String[] ImageIds)

Set 镜像ID列表 。镜像ID如：`img-gvbnzy6f`。array型参数的格式可以参考[API简介](https://cloud.tencent.com/document/api/213/15688)。镜像ID可以通过如下方式获取：

通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回的`ImageId`获取。
通过[镜像控制台](https://console.cloud.tencent.com/cvm/image)获取。

Parameters:

ImageIds - 镜像ID列表 。镜像ID如：`img-gvbnzy6f`。array型参数的格式可以参考[API简介](https://cloud.tencent.com/document/api/213/15688)。镜像ID可以通过如下方式获取：

通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回的`ImageId`获取。

通过[镜像控制台](https://console.cloud.tencent.com/cvm/image)获取。

getFilters

public Filter[] getFilters()

Get 过滤条件，每次请求的`Filters`的上限为10，`Filters.Values`的上限为5。参数不可以同时指定`ImageIds`和`Filters`。详细的过滤条件如下：

image-id

按照【镜像ID】进行过滤。

类型：String

必选：否

image-type

按照【镜像类型】进行过滤。

类型：String

必选：否

可选项：

PRIVATE_IMAGE: 私有镜像 (本账户创建的镜像)

PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像)

SHARED_IMAGE: 共享镜像(其他账户共享给本账户的镜像)

image-name

按照【镜像名称】进行过滤。

类型：String

必选：否

platform

按照【镜像平台】进行过滤，如CentOS。

类型：String

必选：否

tag-key

按照【标签键】进行过滤。

类型：String

必选：否

tag-value

按照【标签值】进行过滤。

类型：String

必选：否

tag:tag-key

按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。

类型：String

必选：否

Returns:

Filters 过滤条件，每次请求的`Filters`的上限为10，`Filters.Values`的上限为5。参数不可以同时指定`ImageIds`和`Filters`。详细的过滤条件如下：

image-id

按照【镜像ID】进行过滤。

类型：String

必选：否

image-type

按照【镜像类型】进行过滤。

类型：String

必选：否

可选项：

PRIVATE_IMAGE: 私有镜像 (本账户创建的镜像)

PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像)

SHARED_IMAGE: 共享镜像(其他账户共享给本账户的镜像)

image-name

按照【镜像名称】进行过滤。

类型：String

必选：否

platform

按照【镜像平台】进行过滤，如CentOS。

类型：String

必选：否

tag-key

按照【标签键】进行过滤。

类型：String

必选：否

tag-value

按照【标签值】进行过滤。

类型：String

必选：否

tag:tag-key

按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。

类型：String

必选：否

setFilters

public void setFilters(Filter[] Filters)

Set 过滤条件，每次请求的`Filters`的上限为10，`Filters.Values`的上限为5。参数不可以同时指定`ImageIds`和`Filters`。详细的过滤条件如下：

image-id

按照【镜像ID】进行过滤。

类型：String

必选：否

image-type

按照【镜像类型】进行过滤。

类型：String

必选：否

可选项：

PRIVATE_IMAGE: 私有镜像 (本账户创建的镜像)

PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像)

SHARED_IMAGE: 共享镜像(其他账户共享给本账户的镜像)

image-name

按照【镜像名称】进行过滤。

类型：String

必选：否

platform

按照【镜像平台】进行过滤，如CentOS。

类型：String

必选：否

tag-key

按照【标签键】进行过滤。

类型：String

必选：否

tag-value

按照【标签值】进行过滤。

类型：String

必选：否

tag:tag-key

按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。

类型：String

必选：否

Parameters:

Filters - 过滤条件，每次请求的`Filters`的上限为10，`Filters.Values`的上限为5。参数不可以同时指定`ImageIds`和`Filters`。详细的过滤条件如下：

image-id

按照【镜像ID】进行过滤。

类型：String

必选：否

image-type

按照【镜像类型】进行过滤。

类型：String

必选：否

可选项：

PRIVATE_IMAGE: 私有镜像 (本账户创建的镜像)

PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像)

SHARED_IMAGE: 共享镜像(其他账户共享给本账户的镜像)

image-name

按照【镜像名称】进行过滤。

类型：String

必选：否

platform

按照【镜像平台】进行过滤，如CentOS。

类型：String

必选：否

tag-key

按照【标签键】进行过滤。

类型：String

必选：否

tag-value

按照【标签值】进行过滤。

类型：String

必选：否

tag:tag-key

按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。

类型：String

必选：否

getOffset

public Long getOffset()

Get 偏移量，默认为0。关于Offset详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。

Returns:

Offset 偏移量，默认为0。关于Offset详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。

setOffset

public void setOffset(Long Offset)

Set 偏移量，默认为0。关于Offset详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。

Parameters:

Offset - 偏移量，默认为0。关于Offset详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。

getLimit

public Long getLimit()

Get 数量限制，默认为20，最大值为100。关于Limit详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。

Returns:

Limit 数量限制，默认为20，最大值为100。关于Limit详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。

setLimit

public void setLimit(Long Limit)

Set 数量限制，默认为20，最大值为100。关于Limit详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。

Parameters:

Limit - 数量限制，默认为20，最大值为100。关于Limit详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。

getInstanceType

public String getInstanceType()

Get 实例类型，如 `S1.SMALL1`

Returns:

InstanceType 实例类型，如 `S1.SMALL1`

setInstanceType

public void setInstanceType(String InstanceType)

Set 实例类型，如 `S1.SMALL1`

Parameters:

InstanceType - 实例类型，如 `S1.SMALL1`

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel