CreateInstanceRequest (rocketmq20220801 1.3.2 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.rocketmq20220801.models.CreateInstanceRequest

public class CreateInstanceRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`CreateInstanceRequest.CreateInstanceRequestNetworkInfo`
`static class`	`CreateInstanceRequest.CreateInstanceRequestNetworkInfoInternetInfo`
`static class`	`CreateInstanceRequest.CreateInstanceRequestNetworkInfoVpcInfo`
`static class`	`CreateInstanceRequest.CreateInstanceRequestProductInfo`

字段概要

字段
限定符和类型	字段和说明
`Boolean`	`autoRenew` Specifies whether to enable auto-renewal for the instance.
`Integer`	`autoRenewPeriod` The auto-renewal cycle of the instance.
`String`	`clientToken` The client token that is used to ensure the idempotence of the request.
`String`	`commodityCode` The commodity code.
`String`	`instanceName` The name of the instance that you want to create.
`CreateInstanceRequest.CreateInstanceRequestNetworkInfo`	`networkInfo` The network configurations.
`String`	`paymentType` The billing method of the instance.
`Integer`	`period` The subscription duration of the instance.
`String`	`periodUnit` The unit of the subscription duration.
`CreateInstanceRequest.CreateInstanceRequestProductInfo`	`productInfo` The information about the instance specifications.
`String`	`remark` The instance description.
`String`	`resourceGroupId` The resource group ID.
`String`	`seriesCode` The primary edition of the instance.
`String`	`serviceCode` The code of the service to which the instance belongs.
`String`	`subSeriesCode` The sub-category edition of the instance.

构造器概要

构造器
构造器和说明

CreateInstanceRequest()

构造器
构造器和说明
`CreateInstanceRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static CreateInstanceRequest`	`build(Map<String,?> map)`
`Boolean`	`getAutoRenew()`
`Integer`	`getAutoRenewPeriod()`
`String`	`getClientToken()`
`String`	`getCommodityCode()`
`String`	`getInstanceName()`
`CreateInstanceRequest.CreateInstanceRequestNetworkInfo`	`getNetworkInfo()`
`String`	`getPaymentType()`
`Integer`	`getPeriod()`
`String`	`getPeriodUnit()`
`CreateInstanceRequest.CreateInstanceRequestProductInfo`	`getProductInfo()`
`String`	`getRemark()`
`String`	`getResourceGroupId()`
`String`	`getSeriesCode()`
`String`	`getServiceCode()`
`String`	`getSubSeriesCode()`
`CreateInstanceRequest`	`setAutoRenew(Boolean autoRenew)`
`CreateInstanceRequest`	`setAutoRenewPeriod(Integer autoRenewPeriod)`
`CreateInstanceRequest`	`setClientToken(String clientToken)`
`CreateInstanceRequest`	`setCommodityCode(String commodityCode)`
`CreateInstanceRequest`	`setInstanceName(String instanceName)`
`CreateInstanceRequest`	`setNetworkInfo(CreateInstanceRequest.CreateInstanceRequestNetworkInfo networkInfo)`
`CreateInstanceRequest`	`setPaymentType(String paymentType)`
`CreateInstanceRequest`	`setPeriod(Integer period)`
`CreateInstanceRequest`	`setPeriodUnit(String periodUnit)`
`CreateInstanceRequest`	`setProductInfo(CreateInstanceRequest.CreateInstanceRequestProductInfo productInfo)`
`CreateInstanceRequest`	`setRemark(String remark)`
`CreateInstanceRequest`	`setResourceGroupId(String resourceGroupId)`
`CreateInstanceRequest`	`setSeriesCode(String seriesCode)`
`CreateInstanceRequest`	`setServiceCode(String serviceCode)`
`CreateInstanceRequest`	`setSubSeriesCode(String subSeriesCode)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - autoRenew
```
@NameInMap(value="autoRenew")
public Boolean autoRenew
```
    Specifies whether to enable auto-renewal for the instance. This parameter takes effect only if you set PaymentType to Subscription.
    
    * true: enable
    
    * false: disable
  - autoRenewPeriod
```
@NameInMap(value="autoRenewPeriod")
public Integer autoRenewPeriod
```
    The auto-renewal cycle of the instance. This parameter takes effect only if you set autoRenew to true. Unit: months.
    
    Valid values:
    
    * Monthly renewal: 1, 2, 3, 6, and 12
  - commodityCode
```
@NameInMap(value="commodityCode")
public String commodityCode
```
    The commodity code.
    
    * ons_rmqpost_public_intl: pay-as-you-go
    
    * ons_rmqsub_public_intl: subscription
  - instanceName
```
@NameInMap(value="instanceName")
public String instanceName
```
    The name of the instance that you want to create.
    
    If you do not configure this parameter, the instance ID is used as the instance name.
  - networkInfo
```
@NameInMap(value="networkInfo")
public CreateInstanceRequest.CreateInstanceRequestNetworkInfo networkInfo
```
    The network configurations.
    
    This parameter is required.
  - paymentType
```
@NameInMap(value="paymentType")
public String paymentType
```
    The billing method of the instance. ApsaraMQ for RocketMQ supports the subscription and pay-as-you-go billing methods.
    
    Valid values:
    
    * PayAsYouGo: This billing method allows you to use resources before you pay for the resources.
    
    * Subscription: This billing method allows you to use resources after you pay for the resources.
    
    For more information, see [Billing methods](https://help.aliyun.com/document_detail/427234.html).
    
    This parameter is required.
  - period
```
@NameInMap(value="period")
public Integer period
```
    The subscription duration of the instance. This parameter takes effect only if you set PaymentType to Subscription.
    
    Valid values:
    
    * Monthly subscription: 1, 2, 3, 4, 5, and 6
    
    * Yearly subscription: 1, 2, and 3
  - periodUnit
```
@NameInMap(value="periodUnit")
public String periodUnit
```
    The unit of the subscription duration.
    
    Valid values:
    
    * Month
    
    * Year
  - productInfo
```
@NameInMap(value="productInfo")
public CreateInstanceRequest.CreateInstanceRequestProductInfo productInfo
```
    The information about the instance specifications.
  - remark
```
@NameInMap(value="remark")
public String remark
```
    The instance description.
  - resourceGroupId
```
@NameInMap(value="resourceGroupId")
public String resourceGroupId
```
    The resource group ID.
  - seriesCode
```
@NameInMap(value="seriesCode")
public String seriesCode
```
    The primary edition of the instance. For information about the differences between primary edition instances, see [Instance selection](https://help.aliyun.com/document_detail/444722.html).
    
    Valid values:
    
    * standard: Standard Edition
    
    * ultimate: Enterprise Platinum Edition
    
    * professional: Professional Edition
    
    > After an instance is created, you can only upgrade the primary edition of the instance. The following editions are sorted in ascending order: Standard Edition, Professional Edition, Enterprise Platinum Edition. For example, you can upgrade an instance of Standard Edition to Professional Edition, but cannot downgrade an instance of Professional Edition to Standard Edition.
    
    This parameter is required.
  - serviceCode
```
@NameInMap(value="serviceCode")
public String serviceCode
```
    The code of the service to which the instance belongs. The service code of ApsaraMQ for RocketMQ is rmq.
    
    This parameter is required.
  - subSeriesCode
```
@NameInMap(value="subSeriesCode")
public String subSeriesCode
```
    The sub-category edition of the instance. For information about the differences between sub-category edition instances, see [Instance selection](https://help.aliyun.com/document_detail/444722.html).
    
    Valid values:
    
    * cluster_ha: High-availability Cluster Edition
    
    * single_node: Standalone Edition
    
    * serverless: Serverless Edition
    
    If you set seriesCode to ultimate, you can set this parameter to only cluster_ha.
    
    > After an instance is created, you cannot change the sub-category edition of the instance.
    
    This parameter is required.
  - clientToken
```
@NameInMap(value="clientToken")
public String clientToken
```
    The client token that is used to ensure the idempotence of the request. You can use the client to generate the value of this parameter, but you must ensure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
- 构造器详细资料
  - CreateInstanceRequest
```
public CreateInstanceRequest()
```
- 方法详细资料
  - build
```
public static CreateInstanceRequest build(Map<String,?> map)
                                   throws Exception
```
    抛出:
    
    Exception
  - setAutoRenew
```
public CreateInstanceRequest setAutoRenew(Boolean autoRenew)
```
  - getAutoRenew
```
public Boolean getAutoRenew()
```
  - setAutoRenewPeriod
```
public CreateInstanceRequest setAutoRenewPeriod(Integer autoRenewPeriod)
```
  - getAutoRenewPeriod
```
public Integer getAutoRenewPeriod()
```
  - setCommodityCode
```
public CreateInstanceRequest setCommodityCode(String commodityCode)
```
  - getCommodityCode
```
public String getCommodityCode()
```
  - setInstanceName
```
public CreateInstanceRequest setInstanceName(String instanceName)
```
  - getInstanceName
```
public String getInstanceName()
```
  - setNetworkInfo
```
public CreateInstanceRequest setNetworkInfo(CreateInstanceRequest.CreateInstanceRequestNetworkInfo networkInfo)
```
  - getNetworkInfo
```
public CreateInstanceRequest.CreateInstanceRequestNetworkInfo getNetworkInfo()
```
  - setPaymentType
```
public CreateInstanceRequest setPaymentType(String paymentType)
```
  - getPaymentType
```
public String getPaymentType()
```
  - setPeriod
```
public CreateInstanceRequest setPeriod(Integer period)
```
  - getPeriod
```
public Integer getPeriod()
```
  - setPeriodUnit
```
public CreateInstanceRequest setPeriodUnit(String periodUnit)
```
  - getPeriodUnit
```
public String getPeriodUnit()
```
  - setProductInfo
```
public CreateInstanceRequest setProductInfo(CreateInstanceRequest.CreateInstanceRequestProductInfo productInfo)
```
  - getProductInfo
```
public CreateInstanceRequest.CreateInstanceRequestProductInfo getProductInfo()
```
  - setRemark
```
public CreateInstanceRequest setRemark(String remark)
```
  - getRemark
```
public String getRemark()
```
  - setResourceGroupId
```
public CreateInstanceRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setSeriesCode
```
public CreateInstanceRequest setSeriesCode(String seriesCode)
```
  - getSeriesCode
```
public String getSeriesCode()
```
  - setServiceCode
```
public CreateInstanceRequest setServiceCode(String serviceCode)
```
  - getServiceCode
```
public String getServiceCode()
```
  - setSubSeriesCode
```
public CreateInstanceRequest setSubSeriesCode(String subSeriesCode)
```
  - getSubSeriesCode
```
public String getSubSeriesCode()
```
  - setClientToken
```
public CreateInstanceRequest setClientToken(String clientToken)
```
  - getClientToken
```
public String getClientToken()
```

类 CreateInstanceRequest

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

autoRenew

autoRenewPeriod

commodityCode

instanceName

networkInfo

paymentType

period

periodUnit

productInfo

remark

resourceGroupId

seriesCode

serviceCode

subSeriesCode

clientToken

构造器详细资料

CreateInstanceRequest

方法详细资料

build

setAutoRenew

getAutoRenew

setAutoRenewPeriod

getAutoRenewPeriod

setCommodityCode

getCommodityCode

setInstanceName

getInstanceName

setNetworkInfo

getNetworkInfo

setPaymentType

getPaymentType

setPeriod

getPeriod

setPeriodUnit

getPeriodUnit

setProductInfo

getProductInfo

setRemark

getRemark

setResourceGroupId

getResourceGroupId

setSeriesCode

getSeriesCode

setServiceCode

getServiceCode

setSubSeriesCode

getSubSeriesCode

setClientToken

getClientToken