com.tencentcloudapi.mongodb.v20190725.models

Class CreateDBInstanceRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mongodb.v20190725.models.CreateDBInstanceRequest

public class CreateDBInstanceRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateDBInstanceRequest()

Method Summary

Modifier and Type	Method and Description
Long	getAutoRenewFlag() Get Auto-renewal flag.
Long	getAutoVoucher() Get Whether to automatically use a voucher.
Long	getClone() Get Valid values: 1 (regular instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance).
String	getClusterType() Get Instance type.
String	getFather() Get Primary instance ID.
Long	getGoodsNum() Get Number of instances.
String	getMachineCode() Get Server type.
Long	getMemory() Get Instance memory size in GB.
String	getMongoVersion() Get Version number.
Long	getNodeNum() Get Number of nodes in each replica set.
String	getPassword() Get Instance password.
Long	getPeriod() Get Instance validity period in months.
Long	getProjectId() Get Project ID.
Long	getReplicateSetNum() Get Number of replica sets.
String[]	getSecurityGroup() Get Security group.
String	getSubnetId() Get VPC subnet ID.
TagInfo[]	getTags() Get Instance tag information.
Long	getVolume() Get Instance disk size in GB.
String	getVpcId() Get VPC ID.
String	getZone() Get Instance region name in the format of ap-guangzhou-2.
void	setAutoRenewFlag(Long AutoRenewFlag) Set Auto-renewal flag.
void	setAutoVoucher(Long AutoVoucher) Set Whether to automatically use a voucher.
void	setClone(Long Clone) Set Valid values: 1 (regular instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance).
void	setClusterType(String ClusterType) Set Instance type.
void	setFather(String Father) Set Primary instance ID.
void	setGoodsNum(Long GoodsNum) Set Number of instances.
void	setMachineCode(String MachineCode) Set Server type.
void	setMemory(Long Memory) Set Instance memory size in GB.
void	setMongoVersion(String MongoVersion) Set Version number.
void	setNodeNum(Long NodeNum) Set Number of nodes in each replica set.
void	setPassword(String Password) Set Instance password.
void	setPeriod(Long Period) Set Instance validity period in months.
void	setProjectId(Long ProjectId) Set Project ID.
void	setReplicateSetNum(Long ReplicateSetNum) Set Number of replica sets.
void	setSecurityGroup(String[] SecurityGroup) Set Security group.
void	setSubnetId(String SubnetId) Set VPC subnet ID.
void	setTags(TagInfo[] Tags) Set Instance tag information.
void	setVolume(Long Volume) Set Instance disk size in GB.
void	setVpcId(String VpcId) Set VPC ID.
void	setZone(String Zone) Set Instance region name in the format of ap-guangzhou-2.
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateDBInstanceRequest

public CreateDBInstanceRequest()

Method Detail

getNodeNum

public Long getNodeNum()

Get Number of nodes in each replica set. Currently, the number of nodes per replica set is fixed at 3, while the number of secondary nodes per shard is customizable. For more information, please see the parameter returned by the `DescribeSpecInfo` API.

Returns:

NodeNum Number of nodes in each replica set. Currently, the number of nodes per replica set is fixed at 3, while the number of secondary nodes per shard is customizable. For more information, please see the parameter returned by the `DescribeSpecInfo` API.

setNodeNum

public void setNodeNum(Long NodeNum)

Set Number of nodes in each replica set. Currently, the number of nodes per replica set is fixed at 3, while the number of secondary nodes per shard is customizable. For more information, please see the parameter returned by the `DescribeSpecInfo` API.

Parameters:

NodeNum - Number of nodes in each replica set. Currently, the number of nodes per replica set is fixed at 3, while the number of secondary nodes per shard is customizable. For more information, please see the parameter returned by the `DescribeSpecInfo` API.

getMemory

public Long getMemory()

Get Instance memory size in GB.

Returns:

Memory Instance memory size in GB.

setMemory

public void setMemory(Long Memory)

Set Instance memory size in GB.

Parameters:

Memory - Instance memory size in GB.

getVolume

public Long getVolume()

Get Instance disk size in GB.

Returns:

Volume Instance disk size in GB.

setVolume

public void setVolume(Long Volume)

Set Instance disk size in GB.

Parameters:

Volume - Instance disk size in GB.

getMongoVersion

public String getMongoVersion()

Get Version number. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. The correspondences between parameters and versions are as follows: MONGO_3_WT: MongoDB 3.2 WiredTiger Edition; MONGO_3_ROCKS: MongoDB 3.2 RocksDB Edition; MONGO_36_WT: MongoDB 3.6 WiredTiger Edition; MONGO_40_WT: MongoDB 4.0 WiredTiger Edition.

Returns:

MongoVersion Version number. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. The correspondences between parameters and versions are as follows: MONGO_3_WT: MongoDB 3.2 WiredTiger Edition; MONGO_3_ROCKS: MongoDB 3.2 RocksDB Edition; MONGO_36_WT: MongoDB 3.6 WiredTiger Edition; MONGO_40_WT: MongoDB 4.0 WiredTiger Edition.

setMongoVersion

public void setMongoVersion(String MongoVersion)

Set Version number. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. The correspondences between parameters and versions are as follows: MONGO_3_WT: MongoDB 3.2 WiredTiger Edition; MONGO_3_ROCKS: MongoDB 3.2 RocksDB Edition; MONGO_36_WT: MongoDB 3.6 WiredTiger Edition; MONGO_40_WT: MongoDB 4.0 WiredTiger Edition.

Parameters:

MongoVersion - Version number. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. The correspondences between parameters and versions are as follows: MONGO_3_WT: MongoDB 3.2 WiredTiger Edition; MONGO_3_ROCKS: MongoDB 3.2 RocksDB Edition; MONGO_36_WT: MongoDB 3.6 WiredTiger Edition; MONGO_40_WT: MongoDB 4.0 WiredTiger Edition.

getGoodsNum

public Long getGoodsNum()

Get Number of instances. Minimum value: 1. Maximum value: 10.

Returns:

GoodsNum Number of instances. Minimum value: 1. Maximum value: 10.

setGoodsNum

public void setGoodsNum(Long GoodsNum)

Set Number of instances. Minimum value: 1. Maximum value: 10.

Parameters:

GoodsNum - Number of instances. Minimum value: 1. Maximum value: 10.

getZone

public String getZone()

Get Instance region name in the format of ap-guangzhou-2.

Returns:

Zone Instance region name in the format of ap-guangzhou-2.

setZone

public void setZone(String Zone)

Set Instance region name in the format of ap-guangzhou-2.

Parameters:

Zone - Instance region name in the format of ap-guangzhou-2.

getPeriod

public Long getPeriod()

Get Instance validity period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.

Returns:

Period Instance validity period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.

setPeriod

public void setPeriod(Long Period)

Set Instance validity period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.

Parameters:

Period - Instance validity period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.

getMachineCode

public String getMachineCode()

Get Server type. Valid values: HIO (high IO), HIO10G (10-gigabit high IO), STDS5 (standard).

Returns:

MachineCode Server type. Valid values: HIO (high IO), HIO10G (10-gigabit high IO), STDS5 (standard).

setMachineCode

public void setMachineCode(String MachineCode)

Set Server type. Valid values: HIO (high IO), HIO10G (10-gigabit high IO), STDS5 (standard).

Parameters:

MachineCode - Server type. Valid values: HIO (high IO), HIO10G (10-gigabit high IO), STDS5 (standard).

getClusterType

public String getClusterType()

Get Instance type. Valid values: REPLSET (replica set), SHARD (sharded cluster), STANDALONE (single-node).

Returns:

ClusterType Instance type. Valid values: REPLSET (replica set), SHARD (sharded cluster), STANDALONE (single-node).

setClusterType

public void setClusterType(String ClusterType)

Set Instance type. Valid values: REPLSET (replica set), SHARD (sharded cluster), STANDALONE (single-node).

Parameters:

ClusterType - Instance type. Valid values: REPLSET (replica set), SHARD (sharded cluster), STANDALONE (single-node).

getReplicateSetNum

public Long getReplicateSetNum()

Get Number of replica sets. To create a replica set instance, set this parameter to 1; to create a shard instance, see the parameters returned by the `DescribeSpecInfo` API; to create a single-node instance, set this parameter to 0.

Returns:

ReplicateSetNum Number of replica sets. To create a replica set instance, set this parameter to 1; to create a shard instance, see the parameters returned by the `DescribeSpecInfo` API; to create a single-node instance, set this parameter to 0.

setReplicateSetNum

public void setReplicateSetNum(Long ReplicateSetNum)

Set Number of replica sets. To create a replica set instance, set this parameter to 1; to create a shard instance, see the parameters returned by the `DescribeSpecInfo` API; to create a single-node instance, set this parameter to 0.

Parameters:

ReplicateSetNum - Number of replica sets. To create a replica set instance, set this parameter to 1; to create a shard instance, see the parameters returned by the `DescribeSpecInfo` API; to create a single-node instance, set this parameter to 0.

getProjectId

public Long getProjectId()

Get Project ID. If this parameter is not set, the default project will be used.

Returns:

ProjectId Project ID. If this parameter is not set, the default project will be used.

setProjectId

public void setProjectId(Long ProjectId)

Set Project ID. If this parameter is not set, the default project will be used.

Parameters:

ProjectId - Project ID. If this parameter is not set, the default project will be used.

getVpcId

public String getVpcId()

Get VPC ID. If this parameter is not set, the classic network will be used. Please use the `DescribeVpcs` API to query the VPC list.

Returns:

VpcId VPC ID. If this parameter is not set, the classic network will be used. Please use the `DescribeVpcs` API to query the VPC list.

setVpcId

public void setVpcId(String VpcId)

Set VPC ID. If this parameter is not set, the classic network will be used. Please use the `DescribeVpcs` API to query the VPC list.

Parameters:

VpcId - VPC ID. If this parameter is not set, the classic network will be used. Please use the `DescribeVpcs` API to query the VPC list.

getSubnetId

public String getSubnetId()

Get VPC subnet ID. If `UniqVpcId` is set, then `UniqSubnetId` will be required. Please use the `DescribeSubnets` API to query the subnet list.

Returns:

SubnetId VPC subnet ID. If `UniqVpcId` is set, then `UniqSubnetId` will be required. Please use the `DescribeSubnets` API to query the subnet list.

setSubnetId

public void setSubnetId(String SubnetId)

Set VPC subnet ID. If `UniqVpcId` is set, then `UniqSubnetId` will be required. Please use the `DescribeSubnets` API to query the subnet list.

Parameters:

SubnetId - VPC subnet ID. If `UniqVpcId` is set, then `UniqSubnetId` will be required. Please use the `DescribeSubnets` API to query the subnet list.

getPassword

public String getPassword()

Get Instance password. If this parameter is not set, you need to set an instance password through the `SetPassword` API after creating an instance. The password can only contain 8-16 characters and must contain at least two of the following types of characters: letters, digits, and special characters `!@#%^*()`.

Returns:

Password Instance password. If this parameter is not set, you need to set an instance password through the `SetPassword` API after creating an instance. The password can only contain 8-16 characters and must contain at least two of the following types of characters: letters, digits, and special characters `!@#%^*()`.

setPassword

public void setPassword(String Password)

Set Instance password. If this parameter is not set, you need to set an instance password through the `SetPassword` API after creating an instance. The password can only contain 8-16 characters and must contain at least two of the following types of characters: letters, digits, and special characters `!@#%^*()`.

Parameters:

Password - Instance password. If this parameter is not set, you need to set an instance password through the `SetPassword` API after creating an instance. The password can only contain 8-16 characters and must contain at least two of the following types of characters: letters, digits, and special characters `!@#%^*()`.

getTags

public TagInfo[] getTags()

Get Instance tag information.

Returns:

Tags Instance tag information.

setTags

public void setTags(TagInfo[] Tags)

Set Instance tag information.

Parameters:

Tags - Instance tag information.

getAutoRenewFlag

public Long getAutoRenewFlag()

Get Auto-renewal flag. Valid values: 0 (auto-renewal not enabled), 1 (auto-renewal enabled). Default value: 0.

Returns:

AutoRenewFlag Auto-renewal flag. Valid values: 0 (auto-renewal not enabled), 1 (auto-renewal enabled). Default value: 0.

setAutoRenewFlag

public void setAutoRenewFlag(Long AutoRenewFlag)

Set Auto-renewal flag. Valid values: 0 (auto-renewal not enabled), 1 (auto-renewal enabled). Default value: 0.

Parameters:

AutoRenewFlag - Auto-renewal flag. Valid values: 0 (auto-renewal not enabled), 1 (auto-renewal enabled). Default value: 0.

getAutoVoucher

public Long getAutoVoucher()

Get Whether to automatically use a voucher. Valid values: 1 (yes), 0 (no). Default value: 0.

Returns:

AutoVoucher Whether to automatically use a voucher. Valid values: 1 (yes), 0 (no). Default value: 0.

setAutoVoucher

public void setAutoVoucher(Long AutoVoucher)

Set Whether to automatically use a voucher. Valid values: 1 (yes), 0 (no). Default value: 0.

Parameters:

AutoVoucher - Whether to automatically use a voucher. Valid values: 1 (yes), 0 (no). Default value: 0.

getClone

public Long getClone()

Get Valid values: 1 (regular instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance).

Returns:

Clone Valid values: 1 (regular instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance).

setClone

public void setClone(Long Clone)

Set Valid values: 1 (regular instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance).

Parameters:

Clone - Valid values: 1 (regular instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance).

getFather

public String getFather()

Get Primary instance ID. It is required for read-only and disaster recovery instances.

Returns:

Father Primary instance ID. It is required for read-only and disaster recovery instances.

setFather

public void setFather(String Father)

Set Primary instance ID. It is required for read-only and disaster recovery instances.

Parameters:

Father - Primary instance ID. It is required for read-only and disaster recovery instances.

getSecurityGroup

public String[] getSecurityGroup()

Get Security group.

Returns:

SecurityGroup Security group.

setSecurityGroup

public void setSecurityGroup(String[] SecurityGroup)

Set Security group.

Parameters:

SecurityGroup - Security group.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel