com.tencentcloudapi.ckafka.v20190819.models

Class CreateInstancePreRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ckafka.v20190819.models.CreateInstancePreRequest

public class CreateInstancePreRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateInstancePreRequest()
CreateInstancePreRequest(CreateInstancePreRequest 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
Long	getAutoVoucher() Get 是否自动选择代金券:1-是;0否。默认为0
Long	getBandWidth() Get 带宽，如果跟控制台规格配比不相符，则无法创建成功
Long	getClusterId() Get 创建实例时可以选择集群Id, 该入参表示集群Id
Long	getDiskSize() Get 磁盘大小，如果跟控制台规格配比不相符，则无法创建成功
String	getDiskType() Get 专业版/高级版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认为 "CLOUD_BASIC"
String	getInstanceName() Get 实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
Long	getInstanceNum() Get 购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例
Long	getInstanceType() Get 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写8。
String	getKafkaVersion() Get CKafka版本号[0.10.2、1.1.1、2.4.1、2.4.2、2.8.1、3.2.3], 默认是1.1.1。2.4.1 与 2.4.2 属于同一个版本，传任意一个均可。
Long	getMsgRetentionTime() Get 可选。实例日志的最长保留时间，单位分钟，默认为10080（7天），最大30天，不填默认0，代表不开启日志保留时间回收策略
Boolean	getMultiZoneFlag() Get 是否创建跨可用区实例，当前参数为 true 时，zoneIds必填
Long	getPartition() Get 分区大小，如果跟控制台规格配比不相符，则无法创建成功
String	getPeriod() Get 预付费购买时长，例如 "1m",就是一个月
Long	getPublicNetworkMonthly() Get 公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。默认值为 0。需要保证传入参数为 3 的整数倍
Long	getRenewFlag() Get 预付费自动续费标记，0表示默认状态(用户未设置，即初始状态)， 1表示自动续费，2表示明确不自动续费(用户设置)
String	getSpecificationsType() Get 实例类型: [标准版实例]填写 "standard" (默认), [专业版实例]填写 "profession",[高级版实例]填写"premium"
String	getSubnetId() Get 子网id，必填
Tag[]	getTags() Get 标签
String	getVpcId() Get vpcId，必填
Long	getZoneId() Get 可用区。当购买多可用区实例时，当前参数为主可用区。需要保证传入的参数和 SubnetId 所在子网属于同一个可用区
Long[]	getZoneIds() Get 可用区列表，购买多可用区实例时为必填项
void	setAutoVoucher(Long AutoVoucher) Set 是否自动选择代金券:1-是;0否。默认为0
void	setBandWidth(Long BandWidth) Set 带宽，如果跟控制台规格配比不相符，则无法创建成功
void	setClusterId(Long ClusterId) Set 创建实例时可以选择集群Id, 该入参表示集群Id
void	setDiskSize(Long DiskSize) Set 磁盘大小，如果跟控制台规格配比不相符，则无法创建成功
void	setDiskType(String DiskType) Set 专业版/高级版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认为 "CLOUD_BASIC"
void	setInstanceName(String InstanceName) Set 实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
void	setInstanceNum(Long InstanceNum) Set 购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例
void	setInstanceType(Long InstanceType) Set 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写8。
void	setKafkaVersion(String KafkaVersion) Set CKafka版本号[0.10.2、1.1.1、2.4.1、2.4.2、2.8.1、3.2.3], 默认是1.1.1。2.4.1 与 2.4.2 属于同一个版本，传任意一个均可。
void	setMsgRetentionTime(Long MsgRetentionTime) Set 可选。实例日志的最长保留时间，单位分钟，默认为10080（7天），最大30天，不填默认0，代表不开启日志保留时间回收策略
void	setMultiZoneFlag(Boolean MultiZoneFlag) Set 是否创建跨可用区实例，当前参数为 true 时，zoneIds必填
void	setPartition(Long Partition) Set 分区大小，如果跟控制台规格配比不相符，则无法创建成功
void	setPeriod(String Period) Set 预付费购买时长，例如 "1m",就是一个月
void	setPublicNetworkMonthly(Long PublicNetworkMonthly) Set 公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。默认值为 0。需要保证传入参数为 3 的整数倍
void	setRenewFlag(Long RenewFlag) Set 预付费自动续费标记，0表示默认状态(用户未设置，即初始状态)， 1表示自动续费，2表示明确不自动续费(用户设置)
void	setSpecificationsType(String SpecificationsType) Set 实例类型: [标准版实例]填写 "standard" (默认), [专业版实例]填写 "profession",[高级版实例]填写"premium"
void	setSubnetId(String SubnetId) Set 子网id，必填
void	setTags(Tag[] Tags) Set 标签
void	setVpcId(String VpcId) Set vpcId，必填
void	setZoneId(Long ZoneId) Set 可用区。当购买多可用区实例时，当前参数为主可用区。需要保证传入的参数和 SubnetId 所在子网属于同一个可用区
void	setZoneIds(Long[] ZoneIds) Set 可用区列表，购买多可用区实例时为必填项
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

CreateInstancePreRequest

public CreateInstancePreRequest()

CreateInstancePreRequest

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

getInstanceName

public String getInstanceName()

Get 实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)

Returns:

InstanceName 实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)

setInstanceName

public void setInstanceName(String InstanceName)

Set 实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)

Parameters:

InstanceName - 实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)

getZoneId

public Long getZoneId()

Get 可用区。当购买多可用区实例时，当前参数为主可用区。需要保证传入的参数和 SubnetId 所在子网属于同一个可用区

Returns:

ZoneId 可用区。当购买多可用区实例时，当前参数为主可用区。需要保证传入的参数和 SubnetId 所在子网属于同一个可用区

setZoneId

public void setZoneId(Long ZoneId)

Set 可用区。当购买多可用区实例时，当前参数为主可用区。需要保证传入的参数和 SubnetId 所在子网属于同一个可用区

Parameters:

ZoneId - 可用区。当购买多可用区实例时，当前参数为主可用区。需要保证传入的参数和 SubnetId 所在子网属于同一个可用区

getPeriod

public String getPeriod()

Get 预付费购买时长，例如 "1m",就是一个月

Returns:

Period 预付费购买时长，例如 "1m",就是一个月

setPeriod

public void setPeriod(String Period)

Set 预付费购买时长，例如 "1m",就是一个月

Parameters:

Period - 预付费购买时长，例如 "1m",就是一个月

getInstanceType

public Long getInstanceType()

Get 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写8。

Returns:

InstanceType 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写8。

setInstanceType

public void setInstanceType(Long InstanceType)

Set 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写8。

Parameters:

InstanceType - 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写8。

getVpcId

public String getVpcId()

Get vpcId，必填

Returns:

VpcId vpcId，必填

setVpcId

public void setVpcId(String VpcId)

Set vpcId，必填

Parameters:

VpcId - vpcId，必填

getSubnetId

public String getSubnetId()

Get 子网id，必填

Returns:

SubnetId 子网id，必填

setSubnetId

public void setSubnetId(String SubnetId)

Set 子网id，必填

Parameters:

SubnetId - 子网id，必填

getMsgRetentionTime

public Long getMsgRetentionTime()

Get 可选。实例日志的最长保留时间，单位分钟，默认为10080（7天），最大30天，不填默认0，代表不开启日志保留时间回收策略

Returns:

MsgRetentionTime 可选。实例日志的最长保留时间，单位分钟，默认为10080（7天），最大30天，不填默认0，代表不开启日志保留时间回收策略

setMsgRetentionTime

public void setMsgRetentionTime(Long MsgRetentionTime)

Set 可选。实例日志的最长保留时间，单位分钟，默认为10080（7天），最大30天，不填默认0，代表不开启日志保留时间回收策略

Parameters:

MsgRetentionTime - 可选。实例日志的最长保留时间，单位分钟，默认为10080（7天），最大30天，不填默认0，代表不开启日志保留时间回收策略

getClusterId

public Long getClusterId()

Get 创建实例时可以选择集群Id, 该入参表示集群Id

Returns:

ClusterId 创建实例时可以选择集群Id, 该入参表示集群Id

setClusterId

public void setClusterId(Long ClusterId)

Set 创建实例时可以选择集群Id, 该入参表示集群Id

Parameters:

ClusterId - 创建实例时可以选择集群Id, 该入参表示集群Id

getRenewFlag

public Long getRenewFlag()

Get 预付费自动续费标记，0表示默认状态(用户未设置，即初始状态)， 1表示自动续费，2表示明确不自动续费(用户设置)

Returns:

RenewFlag 预付费自动续费标记，0表示默认状态(用户未设置，即初始状态)， 1表示自动续费，2表示明确不自动续费(用户设置)

setRenewFlag

public void setRenewFlag(Long RenewFlag)

Set 预付费自动续费标记，0表示默认状态(用户未设置，即初始状态)， 1表示自动续费，2表示明确不自动续费(用户设置)

Parameters:

RenewFlag - 预付费自动续费标记，0表示默认状态(用户未设置，即初始状态)， 1表示自动续费，2表示明确不自动续费(用户设置)

getKafkaVersion

public String getKafkaVersion()

Get CKafka版本号[0.10.2、1.1.1、2.4.1、2.4.2、2.8.1、3.2.3], 默认是1.1.1。2.4.1 与 2.4.2 属于同一个版本，传任意一个均可。

Returns:

KafkaVersion CKafka版本号[0.10.2、1.1.1、2.4.1、2.4.2、2.8.1、3.2.3], 默认是1.1.1。2.4.1 与 2.4.2 属于同一个版本，传任意一个均可。

setKafkaVersion

public void setKafkaVersion(String KafkaVersion)

Set CKafka版本号[0.10.2、1.1.1、2.4.1、2.4.2、2.8.1、3.2.3], 默认是1.1.1。2.4.1 与 2.4.2 属于同一个版本，传任意一个均可。

Parameters:

KafkaVersion - CKafka版本号[0.10.2、1.1.1、2.4.1、2.4.2、2.8.1、3.2.3], 默认是1.1.1。2.4.1 与 2.4.2 属于同一个版本，传任意一个均可。

getSpecificationsType

public String getSpecificationsType()

Get 实例类型: [标准版实例]填写 "standard" (默认), [专业版实例]填写 "profession",[高级版实例]填写"premium"

Returns:

SpecificationsType 实例类型: [标准版实例]填写 "standard" (默认), [专业版实例]填写 "profession",[高级版实例]填写"premium"

setSpecificationsType

public void setSpecificationsType(String SpecificationsType)

Set 实例类型: [标准版实例]填写 "standard" (默认), [专业版实例]填写 "profession",[高级版实例]填写"premium"

Parameters:

SpecificationsType - 实例类型: [标准版实例]填写 "standard" (默认), [专业版实例]填写 "profession",[高级版实例]填写"premium"

getDiskSize

public Long getDiskSize()

Get 磁盘大小，如果跟控制台规格配比不相符，则无法创建成功

Returns:

DiskSize 磁盘大小，如果跟控制台规格配比不相符，则无法创建成功

setDiskSize

public void setDiskSize(Long DiskSize)

Set 磁盘大小，如果跟控制台规格配比不相符，则无法创建成功

Parameters:

DiskSize - 磁盘大小，如果跟控制台规格配比不相符，则无法创建成功

getBandWidth

public Long getBandWidth()

Get 带宽，如果跟控制台规格配比不相符，则无法创建成功

Returns:

BandWidth 带宽，如果跟控制台规格配比不相符，则无法创建成功

setBandWidth

public void setBandWidth(Long BandWidth)

Set 带宽，如果跟控制台规格配比不相符，则无法创建成功

Parameters:

BandWidth - 带宽，如果跟控制台规格配比不相符，则无法创建成功

getPartition

public Long getPartition()

Get 分区大小，如果跟控制台规格配比不相符，则无法创建成功

Returns:

Partition 分区大小，如果跟控制台规格配比不相符，则无法创建成功

setPartition

public void setPartition(Long Partition)

Set 分区大小，如果跟控制台规格配比不相符，则无法创建成功

Parameters:

Partition - 分区大小，如果跟控制台规格配比不相符，则无法创建成功

getTags

public Tag[] getTags()

Get 标签

Returns:

Tags 标签

setTags

public void setTags(Tag[] Tags)

Set 标签

Parameters:

Tags - 标签

getDiskType

public String getDiskType()

Get 专业版/高级版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认为 "CLOUD_BASIC"

Returns:

DiskType 专业版/高级版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认为 "CLOUD_BASIC"

setDiskType

public void setDiskType(String DiskType)

Set 专业版/高级版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认为 "CLOUD_BASIC"

Parameters:

DiskType - 专业版/高级版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认为 "CLOUD_BASIC"

getMultiZoneFlag

public Boolean getMultiZoneFlag()

Get 是否创建跨可用区实例，当前参数为 true 时，zoneIds必填

Returns:

MultiZoneFlag 是否创建跨可用区实例，当前参数为 true 时，zoneIds必填

setMultiZoneFlag

public void setMultiZoneFlag(Boolean MultiZoneFlag)

Set 是否创建跨可用区实例，当前参数为 true 时，zoneIds必填

Parameters:

MultiZoneFlag - 是否创建跨可用区实例，当前参数为 true 时，zoneIds必填

getZoneIds

public Long[] getZoneIds()

Get 可用区列表，购买多可用区实例时为必填项

Returns:

ZoneIds 可用区列表，购买多可用区实例时为必填项

setZoneIds

public void setZoneIds(Long[] ZoneIds)

Set 可用区列表，购买多可用区实例时为必填项

Parameters:

ZoneIds - 可用区列表，购买多可用区实例时为必填项

getPublicNetworkMonthly

public Long getPublicNetworkMonthly()

Get 公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。默认值为 0。需要保证传入参数为 3 的整数倍

Returns:

PublicNetworkMonthly 公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。默认值为 0。需要保证传入参数为 3 的整数倍

setPublicNetworkMonthly

public void setPublicNetworkMonthly(Long PublicNetworkMonthly)

Set 公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。默认值为 0。需要保证传入参数为 3 的整数倍

Parameters:

PublicNetworkMonthly - 公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。默认值为 0。需要保证传入参数为 3 的整数倍

getInstanceNum

public Long getInstanceNum()

Get 购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例

Returns:

InstanceNum 购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例

setInstanceNum

public void setInstanceNum(Long InstanceNum)

Set 购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例

Parameters:

InstanceNum - 购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例

getAutoVoucher

public Long getAutoVoucher()

Get 是否自动选择代金券:1-是;0否。默认为0

Returns:

AutoVoucher 是否自动选择代金券:1-是;0否。默认为0

setAutoVoucher

public void setAutoVoucher(Long AutoVoucher)

Set 是否自动选择代金券:1-是;0否。默认为0

Parameters:

AutoVoucher - 是否自动选择代金券:1-是;0否。默认为0

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel