com.tencentcloudapi.cvm.v20170312.models

Class DescribeReservedInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cvm.v20170312.models.DescribeReservedInstancesRequest

public class DescribeReservedInstancesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeReservedInstancesRequest()
DescribeReservedInstancesRequest(DescribeReservedInstancesRequest 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
Boolean	getDryRun() Get Trial run.
Filter[]	getFilters() Get zone Filter by [availability zones] in which reserved instances can be purchased.
Long	getLimit() Get Number of returned instances.
Long	getOffset() Get Offset.
void	setDryRun(Boolean DryRun) Set Trial run.
void	setFilters(Filter[] Filters) Set zone Filter by [availability zones] in which reserved instances can be purchased.
void	setLimit(Long Limit) Set Number of returned instances.
void	setOffset(Long Offset) Set Offset.
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

DescribeReservedInstancesRequest

public DescribeReservedInstancesRequest()

DescribeReservedInstancesRequest

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

getDryRun

public Boolean getDryRun()

Get Trial run. Default value: false.

Returns:

DryRun Trial run. Default value: false.

setDryRun

public void setDryRun(Boolean DryRun)

Set Trial run. Default value: false.

Parameters:

DryRun - Trial run. Default value: false.

getOffset

public Long getOffset()

Get Offset. Default value: 0. For more information on `Offset`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).

Returns:

Offset Offset. Default value: 0. For more information on `Offset`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).

setOffset

public void setOffset(Long Offset)

Set Offset. Default value: 0. For more information on `Offset`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).

Parameters:

Offset - Offset. Default value: 0. For more information on `Offset`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).

getLimit

public Long getLimit()

Get Number of returned instances. Default value: 20. Maximum value: 100. For more information on `Limit`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).

Returns:

Limit Number of returned instances. Default value: 20. Maximum value: 100. For more information on `Limit`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).

setLimit

public void setLimit(Long Limit)

Set Number of returned instances. Default value: 20. Maximum value: 100. For more information on `Limit`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).

Parameters:

Limit - Number of returned instances. Default value: 20. Maximum value: 100. For more information on `Limit`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).

getFilters

public Filter[] getFilters()

Get

zone

Filter by [availability zones] in which reserved instances can be purchased. For example, ap-guangzhou-1.

Type: String.

Required: No.

Valid values: See the availability zone list.

duration

Filter by [validity periods] of reserved instances, which is the instance purchase duration. For example, 31536000.

Type: Integer.

Unit: Second.

Required: No.

Valid values: 31536000 (1 year) | 94608000 (3 years).

instance-type

Filter by [specifications of reserved instances]. For example, S3.MEDIUM4.

Type: String.

Required: No.

Valid values: See the reserved instance specification list.

instance-family

Filter by [types of reserved instances]. For example, S3.

Type: String.

Required: No.

Valid values: See the reserved instance type list.

offering-type

Filter by payment types]. For example, All Upfront (fully prepaid).

Type: String.

Required: No.

Valid values: All Upfront (fully prepaid) | Partial Upfront (partially prepaid) | No Upfront (non-prepaid).

product-description

Filter by [platform descriptions] (operating system) of reserved instances. For example, linux.

Type: String.

Required: No.

Valid value: linux.

reserved-instances-id

Filter by [IDs of purchased reserved instances]. For example, 650c138f-ae7e-4750-952a-96841d6e9fc1.

Type: String.

Required: No.

state

Filter by [statuses of purchased reserved instances]. For example, active.

Type: String.

Required: No.

Valid values: active (created) | pending (waiting to be created) | retired (expired).

Each request can have up to 10 filters, and each filter can have up to 5 values.

Returns:

Filters

zone

Filter by [availability zones] in which reserved instances can be purchased. For example, ap-guangzhou-1.

Type: String.

Required: No.

Valid values: See the availability zone list.

duration

Filter by [validity periods] of reserved instances, which is the instance purchase duration. For example, 31536000.

Type: Integer.

Unit: Second.

Required: No.

Valid values: 31536000 (1 year) | 94608000 (3 years).

instance-type

Filter by [specifications of reserved instances]. For example, S3.MEDIUM4.

Type: String.

Required: No.

Valid values: See the reserved instance specification list.

instance-family

Filter by [types of reserved instances]. For example, S3.

Type: String.

Required: No.

Valid values: See the reserved instance type list.

offering-type

Filter by payment types]. For example, All Upfront (fully prepaid).

Type: String.

Required: No.

Valid values: All Upfront (fully prepaid) | Partial Upfront (partially prepaid) | No Upfront (non-prepaid).

product-description

Filter by [platform descriptions] (operating system) of reserved instances. For example, linux.

Type: String.

Required: No.

Valid value: linux.

reserved-instances-id

Filter by [IDs of purchased reserved instances]. For example, 650c138f-ae7e-4750-952a-96841d6e9fc1.

Type: String.

Required: No.

state

Filter by [statuses of purchased reserved instances]. For example, active.

Type: String.

Required: No.

Valid values: active (created) | pending (waiting to be created) | retired (expired).

Each request can have up to 10 filters, and each filter can have up to 5 values.

setFilters

public void setFilters(Filter[] Filters)

Set

zone

Filter by [availability zones] in which reserved instances can be purchased. For example, ap-guangzhou-1.

Type: String.

Required: No.

Valid values: See the availability zone list.

duration

Filter by [validity periods] of reserved instances, which is the instance purchase duration. For example, 31536000.

Type: Integer.

Unit: Second.

Required: No.

Valid values: 31536000 (1 year) | 94608000 (3 years).

instance-type

Filter by [specifications of reserved instances]. For example, S3.MEDIUM4.

Type: String.

Required: No.

Valid values: See the reserved instance specification list.

instance-family

Filter by [types of reserved instances]. For example, S3.

Type: String.

Required: No.

Valid values: See the reserved instance type list.

offering-type

Filter by payment types]. For example, All Upfront (fully prepaid).

Type: String.

Required: No.

Valid values: All Upfront (fully prepaid) | Partial Upfront (partially prepaid) | No Upfront (non-prepaid).

product-description

Filter by [platform descriptions] (operating system) of reserved instances. For example, linux.

Type: String.

Required: No.

Valid value: linux.

reserved-instances-id

Filter by [IDs of purchased reserved instances]. For example, 650c138f-ae7e-4750-952a-96841d6e9fc1.

Type: String.

Required: No.

state

Filter by [statuses of purchased reserved instances]. For example, active.

Type: String.

Required: No.

Valid values: active (created) | pending (waiting to be created) | retired (expired).

Each request can have up to 10 filters, and each filter can have up to 5 values.