com.tencentcloudapi.ckafka.v20190819.models

Class CreateInstancePostRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ckafka.v20190819.models.CreateInstancePostRequest

public class CreateInstancePostRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateInstancePostRequest()
CreateInstancePostRequest(CreateInstancePostRequest 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	getBandWidth() Get Private network peak bandwidth of an instance in MB/sec.
Long	getClusterId() Get Cluster ID, which can be selected when you create an instance.
Long	getDiskSize() Get Instance disk size, which must meet the requirement of the instance’s specification.
String	getDiskType() Get Instance disk type.
String	getInstanceName() Get Instance name, which is a string of up to 64 characters.
Long	getInstanceNum() Get The number of purchased instances.
Long	getInstanceType() Get Instance specification.
String	getKafkaVersion() Get Instance version.
Long	getMsgRetentionTime() Get The maximum instance log retention period in minutes by default.
Boolean	getMultiZoneFlag() Get Whether the current instance is a multi-AZ instance
Long	getPartition() Get The maximum number of partitions of the instance, which must meet the requirement of the instance’s specification.
Long	getPublicNetworkMonthly() Get Public network bandwidth in Mbps.
String	getSpecificationsType() Get Instance type.
String	getSubnetId() Get ID of the subnet where the default access point of the created instance resides.
Long	getTopicNum() Get The maximum number of topics of the instance, which must meet the requirement of the instance’s specification.
String	getVpcId() Get ID of the VPC where the default access point of the created instance resides.
Long	getZoneId() Get AZ of the instance.
Long[]	getZoneIds() Get This parameter indicates the list of AZ IDs when the instance is deployed in multiple AZs.
void	setBandWidth(Long BandWidth) Set Private network peak bandwidth of an instance in MB/sec.
void	setClusterId(Long ClusterId) Set Cluster ID, which can be selected when you create an instance.
void	setDiskSize(Long DiskSize) Set Instance disk size, which must meet the requirement of the instance’s specification.
void	setDiskType(String DiskType) Set Instance disk type.
void	setInstanceName(String InstanceName) Set Instance name, which is a string of up to 64 characters.
void	setInstanceNum(Long InstanceNum) Set The number of purchased instances.
void	setInstanceType(Long InstanceType) Set Instance specification.
void	setKafkaVersion(String KafkaVersion) Set Instance version.
void	setMsgRetentionTime(Long MsgRetentionTime) Set The maximum instance log retention period in minutes by default.
void	setMultiZoneFlag(Boolean MultiZoneFlag) Set Whether the current instance is a multi-AZ instance
void	setPartition(Long Partition) Set The maximum number of partitions of the instance, which must meet the requirement of the instance’s specification.
void	setPublicNetworkMonthly(Long PublicNetworkMonthly) Set Public network bandwidth in Mbps.
void	setSpecificationsType(String SpecificationsType) Set Instance type.
void	setSubnetId(String SubnetId) Set ID of the subnet where the default access point of the created instance resides.
void	setTopicNum(Long TopicNum) Set The maximum number of topics of the instance, which must meet the requirement of the instance’s specification.
void	setVpcId(String VpcId) Set ID of the VPC where the default access point of the created instance resides.
void	setZoneId(Long ZoneId) Set AZ of the instance.
void	setZoneIds(Long[] ZoneIds) Set This parameter indicates the list of AZ IDs when the instance is deployed in multiple AZs.
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

CreateInstancePostRequest

public CreateInstancePostRequest()

CreateInstancePostRequest

public CreateInstancePostRequest(CreateInstancePostRequest 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 Instance name, which is a string of up to 64 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.

Returns:

InstanceName Instance name, which is a string of up to 64 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.

setInstanceName

public void setInstanceName(String InstanceName)

Set Instance name, which is a string of up to 64 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.

Parameters:

InstanceName - Instance name, which is a string of up to 64 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.

getBandWidth

public Long getBandWidth()

Get Private network peak bandwidth of an instance in MB/sec. If you create a Standard Edition instance, pass in the corresponding peak bandwidth for the current instance specification. If you create a Pro Edition instance, configure the peak bandwidth, partition count, and other parameters as required by Pro Edition.

Returns:

BandWidth Private network peak bandwidth of an instance in MB/sec. If you create a Standard Edition instance, pass in the corresponding peak bandwidth for the current instance specification. If you create a Pro Edition instance, configure the peak bandwidth, partition count, and other parameters as required by Pro Edition.

setBandWidth

public void setBandWidth(Long BandWidth)

Set Private network peak bandwidth of an instance in MB/sec. If you create a Standard Edition instance, pass in the corresponding peak bandwidth for the current instance specification. If you create a Pro Edition instance, configure the peak bandwidth, partition count, and other parameters as required by Pro Edition.

Parameters:

BandWidth - Private network peak bandwidth of an instance in MB/sec. If you create a Standard Edition instance, pass in the corresponding peak bandwidth for the current instance specification. If you create a Pro Edition instance, configure the peak bandwidth, partition count, and other parameters as required by Pro Edition.

getVpcId

public String getVpcId()

Get ID of the VPC where the default access point of the created instance resides. This parameter is required as instances cannot be created in the classic network currently.

Returns:

VpcId ID of the VPC where the default access point of the created instance resides. This parameter is required as instances cannot be created in the classic network currently.

setVpcId

public void setVpcId(String VpcId)

Set ID of the VPC where the default access point of the created instance resides. This parameter is required as instances cannot be created in the classic network currently.

Parameters:

VpcId - ID of the VPC where the default access point of the created instance resides. This parameter is required as instances cannot be created in the classic network currently.

getSubnetId

public String getSubnetId()

Get ID of the subnet where the default access point of the created instance resides.

Returns:

SubnetId ID of the subnet where the default access point of the created instance resides.

setSubnetId

public void setSubnetId(String SubnetId)

Set ID of the subnet where the default access point of the created instance resides.

Parameters:

SubnetId - ID of the subnet where the default access point of the created instance resides.

getInstanceType

public Long getInstanceType()

Get Instance specification. This parameter is required for a Standard Edition instance but not for a Pro Edition instance. Valid values: `1` (Small), `2` (Standard), `3` (Advanced), `4` (Large), `5` (Xlarge L1), `6` (Xlarge L2), `7` (Xlarge L3), `8` (Xlarge L4),

Returns:

InstanceType Instance specification. This parameter is required for a Standard Edition instance but not for a Pro Edition instance. Valid values: `1` (Small), `2` (Standard), `3` (Advanced), `4` (Large), `5` (Xlarge L1), `6` (Xlarge L2), `7` (Xlarge L3), `8` (Xlarge L4),

setInstanceType

public void setInstanceType(Long InstanceType)

Set Instance specification. This parameter is required for a Standard Edition instance but not for a Pro Edition instance. Valid values: `1` (Small), `2` (Standard), `3` (Advanced), `4` (Large), `5` (Xlarge L1), `6` (Xlarge L2), `7` (Xlarge L3), `8` (Xlarge L4),

Parameters:

InstanceType - Instance specification. This parameter is required for a Standard Edition instance but not for a Pro Edition instance. Valid values: `1` (Small), `2` (Standard), `3` (Advanced), `4` (Large), `5` (Xlarge L1), `6` (Xlarge L2), `7` (Xlarge L3), `8` (Xlarge L4),

getMsgRetentionTime

public Long getMsgRetentionTime()

Get The maximum instance log retention period in minutes by default. If this parameter is left empty, the default retention period is 1,440 minutes (1 day) to 30 days. If the message retention period of the topic is explicitly set, it will prevail.

Returns:

MsgRetentionTime The maximum instance log retention period in minutes by default. If this parameter is left empty, the default retention period is 1,440 minutes (1 day) to 30 days. If the message retention period of the topic is explicitly set, it will prevail.

setMsgRetentionTime

public void setMsgRetentionTime(Long MsgRetentionTime)

Set The maximum instance log retention period in minutes by default. If this parameter is left empty, the default retention period is 1,440 minutes (1 day) to 30 days. If the message retention period of the topic is explicitly set, it will prevail.

Parameters:

MsgRetentionTime - The maximum instance log retention period in minutes by default. If this parameter is left empty, the default retention period is 1,440 minutes (1 day) to 30 days. If the message retention period of the topic is explicitly set, it will prevail.

getClusterId

public Long getClusterId()

Get Cluster ID, which can be selected when you create an instance. You don’t need to pass in this parameter if the cluster where the instance resides is not specified.

Returns:

ClusterId Cluster ID, which can be selected when you create an instance. You don’t need to pass in this parameter if the cluster where the instance resides is not specified.

setClusterId

public void setClusterId(Long ClusterId)

Set Cluster ID, which can be selected when you create an instance. You don’t need to pass in this parameter if the cluster where the instance resides is not specified.

Parameters:

ClusterId - Cluster ID, which can be selected when you create an instance. You don’t need to pass in this parameter if the cluster where the instance resides is not specified.

getKafkaVersion

public String getKafkaVersion()

Get Instance version. Valid values: `0.10.2`, `1.1.1`, `2.4.2`, and `2.8.1`.

Returns:

KafkaVersion Instance version. Valid values: `0.10.2`, `1.1.1`, `2.4.2`, and `2.8.1`.

setKafkaVersion

public void setKafkaVersion(String KafkaVersion)

Set Instance version. Valid values: `0.10.2`, `1.1.1`, `2.4.2`, and `2.8.1`.

Parameters:

KafkaVersion - Instance version. Valid values: `0.10.2`, `1.1.1`, `2.4.2`, and `2.8.1`.

getSpecificationsType

public String getSpecificationsType()

Get Instance type. Valid values: `standard` (Standard Edition), `profession` (Pro Edition)

Returns:

SpecificationsType Instance type. Valid values: `standard` (Standard Edition), `profession` (Pro Edition)

setSpecificationsType

public void setSpecificationsType(String SpecificationsType)

Set Instance type. Valid values: `standard` (Standard Edition), `profession` (Pro Edition)

Parameters:

SpecificationsType - Instance type. Valid values: `standard` (Standard Edition), `profession` (Pro Edition)

getDiskType

public String getDiskType()

Get Instance disk type. Valid values: `CLOUD_BASIC` (Premium Cloud Storage), `CLOUD_SSD` (SSD). If this parameter is left empty, the default value `CLOUD_BASIC` will be used.

Returns:

DiskType Instance disk type. Valid values: `CLOUD_BASIC` (Premium Cloud Storage), `CLOUD_SSD` (SSD). If this parameter is left empty, the default value `CLOUD_BASIC` will be used.

setDiskType

public void setDiskType(String DiskType)

Set Instance disk type. Valid values: `CLOUD_BASIC` (Premium Cloud Storage), `CLOUD_SSD` (SSD). If this parameter is left empty, the default value `CLOUD_BASIC` will be used.

Parameters:

DiskType - Instance disk type. Valid values: `CLOUD_BASIC` (Premium Cloud Storage), `CLOUD_SSD` (SSD). If this parameter is left empty, the default value `CLOUD_BASIC` will be used.

getDiskSize

public Long getDiskSize()

Get Instance disk size, which must meet the requirement of the instance’s specification.

Returns:

DiskSize Instance disk size, which must meet the requirement of the instance’s specification.

setDiskSize

public void setDiskSize(Long DiskSize)

Set Instance disk size, which must meet the requirement of the instance’s specification.

Parameters:

DiskSize - Instance disk size, which must meet the requirement of the instance’s specification.

getPartition

public Long getPartition()

Get The maximum number of partitions of the instance, which must meet the requirement of the instance’s specification.

Returns:

Partition The maximum number of partitions of the instance, which must meet the requirement of the instance’s specification.

setPartition

public void setPartition(Long Partition)

Set The maximum number of partitions of the instance, which must meet the requirement of the instance’s specification.

Parameters:

Partition - The maximum number of partitions of the instance, which must meet the requirement of the instance’s specification.

getTopicNum

public Long getTopicNum()

Get The maximum number of topics of the instance, which must meet the requirement of the instance’s specification.

Returns:

TopicNum The maximum number of topics of the instance, which must meet the requirement of the instance’s specification.

setTopicNum

public void setTopicNum(Long TopicNum)

Set The maximum number of topics of the instance, which must meet the requirement of the instance’s specification.

Parameters:

TopicNum - The maximum number of topics of the instance, which must meet the requirement of the instance’s specification.

getZoneId

public Long getZoneId()

Get AZ of the instance. When a multi-AZ instance is created, the value of this parameter is the AZ ID of the subnet where the instance’s default access point resides.

Returns:

ZoneId AZ of the instance. When a multi-AZ instance is created, the value of this parameter is the AZ ID of the subnet where the instance’s default access point resides.

setZoneId

public void setZoneId(Long ZoneId)

Set AZ of the instance. When a multi-AZ instance is created, the value of this parameter is the AZ ID of the subnet where the instance’s default access point resides.

Parameters:

ZoneId - AZ of the instance. When a multi-AZ instance is created, the value of this parameter is the AZ ID of the subnet where the instance’s default access point resides.

getMultiZoneFlag

public Boolean getMultiZoneFlag()

Get Whether the current instance is a multi-AZ instance

Returns:

MultiZoneFlag Whether the current instance is a multi-AZ instance

setMultiZoneFlag

public void setMultiZoneFlag(Boolean MultiZoneFlag)

Set Whether the current instance is a multi-AZ instance

Parameters:

MultiZoneFlag - Whether the current instance is a multi-AZ instance

getZoneIds

public Long[] getZoneIds()

Get This parameter indicates the list of AZ IDs when the instance is deployed in multiple AZs. Note that `ZoneId` must be included in the array of this parameter.

Returns:

ZoneIds This parameter indicates the list of AZ IDs when the instance is deployed in multiple AZs. Note that `ZoneId` must be included in the array of this parameter.

setZoneIds

public void setZoneIds(Long[] ZoneIds)

Set This parameter indicates the list of AZ IDs when the instance is deployed in multiple AZs. Note that `ZoneId` must be included in the array of this parameter.

Parameters:

ZoneIds - This parameter indicates the list of AZ IDs when the instance is deployed in multiple AZs. Note that `ZoneId` must be included in the array of this parameter.

getInstanceNum

public Long getInstanceNum()

Get The number of purchased instances. Default value: `1`. This parameter is optional. If it is passed in, multiple instances will be created, with their names being `instanceName` plus different suffixes.

Returns:

InstanceNum The number of purchased instances. Default value: `1`. This parameter is optional. If it is passed in, multiple instances will be created, with their names being `instanceName` plus different suffixes.

setInstanceNum

public void setInstanceNum(Long InstanceNum)

Set The number of purchased instances. Default value: `1`. This parameter is optional. If it is passed in, multiple instances will be created, with their names being `instanceName` plus different suffixes.

Parameters:

InstanceNum - The number of purchased instances. Default value: `1`. This parameter is optional. If it is passed in, multiple instances will be created, with their names being `instanceName` plus different suffixes.

getPublicNetworkMonthly

public Long getPublicNetworkMonthly()

Get Public network bandwidth in Mbps. The 3 Mbps of free bandwidth is not included here by default. For example, if you need 3 Mbps of public network bandwidth, pass in `0`; if you need 6 Mbps, pass in `3`. The value must be an integer multiple of 3.

Returns:

PublicNetworkMonthly Public network bandwidth in Mbps. The 3 Mbps of free bandwidth is not included here by default. For example, if you need 3 Mbps of public network bandwidth, pass in `0`; if you need 6 Mbps, pass in `3`. The value must be an integer multiple of 3.

setPublicNetworkMonthly

public void setPublicNetworkMonthly(Long PublicNetworkMonthly)

Set Public network bandwidth in Mbps. The 3 Mbps of free bandwidth is not included here by default. For example, if you need 3 Mbps of public network bandwidth, pass in `0`; if you need 6 Mbps, pass in `3`. The value must be an integer multiple of 3.

Parameters:

PublicNetworkMonthly - Public network bandwidth in Mbps. The 3 Mbps of free bandwidth is not included here by default. For example, if you need 3 Mbps of public network bandwidth, pass in `0`; if you need 6 Mbps, pass in `3`. The value must be an integer multiple of 3.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel