com.tencentcloudapi.redis.v20180412.models

Class CreateInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.redis.v20180412.models.CreateInstancesRequest

public class CreateInstancesRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateInstancesRequest()
CreateInstancesRequest(CreateInstancesRequest 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	getAutoRenew() Get Auto-renewal flag.
Long	getBillingMode() Get Billing method.
Long	getGoodsNum() Get Number of instances.
String	getInstanceName() Get Instance name.
Long	getMemSize() Get Instance capacity in MB.
Boolean	getNoAuth() Get Whether to support the password-free feature.
RedisNodeInfo[]	getNodeSet() Get Node information of an instance.
String	getPassword() Get Instance password.
Long	getPeriod() Get Purchased usage period in months.
Long	getProjectId() Get Project ID.
Long	getRedisReplicasNum() Get Number of replicas in an instance.
Long	getRedisShardNum() Get Number of shards in an instance.
Boolean	getReplicasReadonly() Get Whether to support read-only replicas.
ResourceTag[]	getResourceTags() Get The tag bound with the instance to be purchased
String[]	getSecurityGroupIdList() Get Array of security group IDs
String	getSubnetId() Get In a classic network, `subnetId` is invalid.
Long	getTypeId() Get Instance type.
String	getVpcId() Get VPC ID, such as "vpc-sad23jfdfk".
Long	getVPort() Get User-defined port.
Long	getZoneId() Get Availability zone ID of the instance.
void	setAutoRenew(Long AutoRenew) Set Auto-renewal flag.
void	setBillingMode(Long BillingMode) Set Billing method.
void	setGoodsNum(Long GoodsNum) Set Number of instances.
void	setInstanceName(String InstanceName) Set Instance name.
void	setMemSize(Long MemSize) Set Instance capacity in MB.
void	setNoAuth(Boolean NoAuth) Set Whether to support the password-free feature.
void	setNodeSet(RedisNodeInfo[] NodeSet) Set Node information of an instance.
void	setPassword(String Password) Set Instance password.
void	setPeriod(Long Period) Set Purchased usage period in months.
void	setProjectId(Long ProjectId) Set Project ID.
void	setRedisReplicasNum(Long RedisReplicasNum) Set Number of replicas in an instance.
void	setRedisShardNum(Long RedisShardNum) Set Number of shards in an instance.
void	setReplicasReadonly(Boolean ReplicasReadonly) Set Whether to support read-only replicas.
void	setResourceTags(ResourceTag[] ResourceTags) Set The tag bound with the instance to be purchased
void	setSecurityGroupIdList(String[] SecurityGroupIdList) Set Array of security group IDs
void	setSubnetId(String SubnetId) Set In a classic network, `subnetId` is invalid.
void	setTypeId(Long TypeId) Set Instance type.
void	setVpcId(String VpcId) Set VPC ID, such as "vpc-sad23jfdfk".
void	setVPort(Long VPort) Set User-defined port.
void	setZoneId(Long ZoneId) Set Availability zone ID of the instance.
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

CreateInstancesRequest

public CreateInstancesRequest()

CreateInstancesRequest

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

getZoneId

public Long getZoneId()

Get Availability zone ID of the instance. For more information, please see [Regions and AZs](https://intl.cloud.tencent.com/document/product/239/4106?from_cn_redirect=1).

Returns:

ZoneId Availability zone ID of the instance. For more information, please see [Regions and AZs](https://intl.cloud.tencent.com/document/product/239/4106?from_cn_redirect=1).

setZoneId

public void setZoneId(Long ZoneId)

Set Availability zone ID of the instance. For more information, please see [Regions and AZs](https://intl.cloud.tencent.com/document/product/239/4106?from_cn_redirect=1).

Parameters:

ZoneId - Availability zone ID of the instance. For more information, please see [Regions and AZs](https://intl.cloud.tencent.com/document/product/239/4106?from_cn_redirect=1).

getTypeId

public Long getTypeId()

Get Instance type. Valid values: 2 (Redis 2.8 Memory Edition in standard architecture), 3 (CKV 3.2 Memory Edition in standard architecture), 4 (CKV 3.2 Memory Edition in cluster architecture), 6 (Redis 4.0 Memory Edition in standard architecture), 7 (Redis 4.0 Memory Edition in cluster architecture), 8 (Redis 5.0 Memory Edition in standard architecture), 9 (Redis 5.0 Memory Edition in cluster architecture).

Returns:

TypeId Instance type. Valid values: 2 (Redis 2.8 Memory Edition in standard architecture), 3 (CKV 3.2 Memory Edition in standard architecture), 4 (CKV 3.2 Memory Edition in cluster architecture), 6 (Redis 4.0 Memory Edition in standard architecture), 7 (Redis 4.0 Memory Edition in cluster architecture), 8 (Redis 5.0 Memory Edition in standard architecture), 9 (Redis 5.0 Memory Edition in cluster architecture).

setTypeId

public void setTypeId(Long TypeId)

Set Instance type. Valid values: 2 (Redis 2.8 Memory Edition in standard architecture), 3 (CKV 3.2 Memory Edition in standard architecture), 4 (CKV 3.2 Memory Edition in cluster architecture), 6 (Redis 4.0 Memory Edition in standard architecture), 7 (Redis 4.0 Memory Edition in cluster architecture), 8 (Redis 5.0 Memory Edition in standard architecture), 9 (Redis 5.0 Memory Edition in cluster architecture).

Parameters:

TypeId - Instance type. Valid values: 2 (Redis 2.8 Memory Edition in standard architecture), 3 (CKV 3.2 Memory Edition in standard architecture), 4 (CKV 3.2 Memory Edition in cluster architecture), 6 (Redis 4.0 Memory Edition in standard architecture), 7 (Redis 4.0 Memory Edition in cluster architecture), 8 (Redis 5.0 Memory Edition in standard architecture), 9 (Redis 5.0 Memory Edition in cluster architecture).

getMemSize

public Long getMemSize()

Get Instance capacity in MB. The value should be a multiple of 1,024 and is subject to the specifications returned by the [DescribeProductInfo](https://intl.cloud.tencent.com/document/api/239/30600?from_cn_redirect=1) API.

Returns:

MemSize Instance capacity in MB. The value should be a multiple of 1,024 and is subject to the specifications returned by the [DescribeProductInfo](https://intl.cloud.tencent.com/document/api/239/30600?from_cn_redirect=1) API.

setMemSize

public void setMemSize(Long MemSize)

Set Instance capacity in MB. The value should be a multiple of 1,024 and is subject to the specifications returned by the [DescribeProductInfo](https://intl.cloud.tencent.com/document/api/239/30600?from_cn_redirect=1) API.

Parameters:

MemSize - Instance capacity in MB. The value should be a multiple of 1,024 and is subject to the specifications returned by the [DescribeProductInfo](https://intl.cloud.tencent.com/document/api/239/30600?from_cn_redirect=1) API.

getGoodsNum

public Long getGoodsNum()

Get Number of instances. The actual quantity purchasable at a time is subject to the specifications returned by the [DescribeProductInfo](https://intl.cloud.tencent.com/document/api/239/30600?from_cn_redirect=1) API.

Returns:

GoodsNum Number of instances. The actual quantity purchasable at a time is subject to the specifications returned by the [DescribeProductInfo](https://intl.cloud.tencent.com/document/api/239/30600?from_cn_redirect=1) API.

setGoodsNum

public void setGoodsNum(Long GoodsNum)

Set Number of instances. The actual quantity purchasable at a time is subject to the specifications returned by the [DescribeProductInfo](https://intl.cloud.tencent.com/document/api/239/30600?from_cn_redirect=1) API.

Parameters:

GoodsNum - Number of instances. The actual quantity purchasable at a time is subject to the specifications returned by the [DescribeProductInfo](https://intl.cloud.tencent.com/document/api/239/30600?from_cn_redirect=1) API.

getPeriod

public Long getPeriod()

Get Purchased usage period in months. which is required when creating an instance. For pay-as-you-go instances, the valid value is 1; for monthly subscription instances, the value range is [1,2,3,4,5,6,7,8,9,10,11,12,24,36].

Returns:

Period Purchased usage period in months. which is required when creating an instance. For pay-as-you-go instances, the valid value is 1; for monthly subscription instances, the value range is [1,2,3,4,5,6,7,8,9,10,11,12,24,36].

setPeriod

public void setPeriod(Long Period)

Set Purchased usage period in months. which is required when creating an instance. For pay-as-you-go instances, the valid value is 1; for monthly subscription instances, the value range is [1,2,3,4,5,6,7,8,9,10,11,12,24,36].

Parameters:

Period - Purchased usage period in months. which is required when creating an instance. For pay-as-you-go instances, the valid value is 1; for monthly subscription instances, the value range is [1,2,3,4,5,6,7,8,9,10,11,12,24,36].

getBillingMode

public Long getBillingMode()

Get Billing method. 0: pay as you go

Returns:

BillingMode Billing method. 0: pay as you go

setBillingMode

public void setBillingMode(Long BillingMode)

Set Billing method. 0: pay as you go

Parameters:

BillingMode - Billing method. 0: pay as you go

getPassword

public String getPassword()

Get Instance password. If the input parameter `NoAuth` is `true` and a VPC is used, the `Password` is optional; otherwise, it is required. If the instance type parameter `TypeId` indicates Redis 2.8, 4.0, or 5.0, the password cannot start with "/" and must contain 8-30 characters which are comprised of at least two of the following: lowercase letters, uppercase letters, digits, and special symbols (()`~!@#$%^&*-+=_|{}[]:;<>,.?/). If the instance type parameter `TypeId` indicates CKV 3.2, the password contains 8-30 characters which must be comprised of only letters and digits.

Returns:

Password Instance password. If the input parameter `NoAuth` is `true` and a VPC is used, the `Password` is optional; otherwise, it is required. If the instance type parameter `TypeId` indicates Redis 2.8, 4.0, or 5.0, the password cannot start with "/" and must contain 8-30 characters which are comprised of at least two of the following: lowercase letters, uppercase letters, digits, and special symbols (()`~!@#$%^&*-+=_|{}[]:;<>,.?/). If the instance type parameter `TypeId` indicates CKV 3.2, the password contains 8-30 characters which must be comprised of only letters and digits.

setPassword

public void setPassword(String Password)

Set Instance password. If the input parameter `NoAuth` is `true` and a VPC is used, the `Password` is optional; otherwise, it is required. If the instance type parameter `TypeId` indicates Redis 2.8, 4.0, or 5.0, the password cannot start with "/" and must contain 8-30 characters which are comprised of at least two of the following: lowercase letters, uppercase letters, digits, and special symbols (()`~!@#$%^&*-+=_|{}[]:;<>,.?/). If the instance type parameter `TypeId` indicates CKV 3.2, the password contains 8-30 characters which must be comprised of only letters and digits.

Parameters:

Password - Instance password. If the input parameter `NoAuth` is `true` and a VPC is used, the `Password` is optional; otherwise, it is required. If the instance type parameter `TypeId` indicates Redis 2.8, 4.0, or 5.0, the password cannot start with "/" and must contain 8-30 characters which are comprised of at least two of the following: lowercase letters, uppercase letters, digits, and special symbols (()`~!@#$%^&*-+=_|{}[]:;<>,.?/). If the instance type parameter `TypeId` indicates CKV 3.2, the password contains 8-30 characters which must be comprised of only letters and digits.

getVpcId

public String getVpcId()

Get VPC ID, such as "vpc-sad23jfdfk". If this parameter is not passed in, the classic network will be selected by default. The parameter value can be queried by the `DescribeVpcs` API.

Returns:

VpcId VPC ID, such as "vpc-sad23jfdfk". If this parameter is not passed in, the classic network will be selected by default. The parameter value can be queried by the `DescribeVpcs` API.

setVpcId

public void setVpcId(String VpcId)

Set VPC ID, such as "vpc-sad23jfdfk". If this parameter is not passed in, the classic network will be selected by default. The parameter value can be queried by the `DescribeVpcs` API.

Parameters:

VpcId - VPC ID, such as "vpc-sad23jfdfk". If this parameter is not passed in, the classic network will be selected by default. The parameter value can be queried by the `DescribeVpcs` API.

getSubnetId

public String getSubnetId()

Get In a classic network, `subnetId` is invalid. In a VPC subnet, the value can be queried by the `DescribeSubnets` API, such as "subnet-fdj24n34j2".

Returns:

SubnetId In a classic network, `subnetId` is invalid. In a VPC subnet, the value can be queried by the `DescribeSubnets` API, such as "subnet-fdj24n34j2".

setSubnetId

public void setSubnetId(String SubnetId)

Set In a classic network, `subnetId` is invalid. In a VPC subnet, the value can be queried by the `DescribeSubnets` API, such as "subnet-fdj24n34j2".

Parameters:

SubnetId - In a classic network, `subnetId` is invalid. In a VPC subnet, the value can be queried by the `DescribeSubnets` API, such as "subnet-fdj24n34j2".

getProjectId

public Long getProjectId()

Get Project ID. The value is subject to the `projectId` returned by the `DescribeProject` API.

Returns:

ProjectId Project ID. The value is subject to the `projectId` returned by the `DescribeProject` API.

setProjectId

public void setProjectId(Long ProjectId)

Set Project ID. The value is subject to the `projectId` returned by the `DescribeProject` API.

Parameters:

ProjectId - Project ID. The value is subject to the `projectId` returned by the `DescribeProject` API.

getAutoRenew

public Long getAutoRenew()

Get Auto-renewal flag. Valid values: 0 (default status, indicating manual renewal), 1 (auto-renewal enabled), 2 (auto-renewal disabled)

Returns:

AutoRenew Auto-renewal flag. Valid values: 0 (default status, indicating manual renewal), 1 (auto-renewal enabled), 2 (auto-renewal disabled)

setAutoRenew

public void setAutoRenew(Long AutoRenew)

Set Auto-renewal flag. Valid values: 0 (default status, indicating manual renewal), 1 (auto-renewal enabled), 2 (auto-renewal disabled)

Parameters:

AutoRenew - Auto-renewal flag. Valid values: 0 (default status, indicating manual renewal), 1 (auto-renewal enabled), 2 (auto-renewal disabled)

getSecurityGroupIdList

public String[] getSecurityGroupIdList()

Get Array of security group IDs

Returns:

SecurityGroupIdList Array of security group IDs

setSecurityGroupIdList

public void setSecurityGroupIdList(String[] SecurityGroupIdList)

Set Array of security group IDs

Parameters:

SecurityGroupIdList - Array of security group IDs

getVPort

public Long getVPort()

Get User-defined port. If this parameter is left empty, 6379 will be used by default. Value range: [1024, 65535].

Returns:

VPort User-defined port. If this parameter is left empty, 6379 will be used by default. Value range: [1024, 65535].

setVPort

public void setVPort(Long VPort)

Set User-defined port. If this parameter is left empty, 6379 will be used by default. Value range: [1024, 65535].

Parameters:

VPort - User-defined port. If this parameter is left empty, 6379 will be used by default. Value range: [1024, 65535].

getRedisShardNum

public Long getRedisShardNum()

Get Number of shards in an instance. This parameter is required for instances in cluster architecture. Value range: [3,5,8,12,16,24,32,64,96,128].

Returns:

RedisShardNum Number of shards in an instance. This parameter is required for instances in cluster architecture. Value range: [3,5,8,12,16,24,32,64,96,128].

setRedisShardNum

public void setRedisShardNum(Long RedisShardNum)

Set Number of shards in an instance. This parameter is required for instances in cluster architecture. Value range: [3,5,8,12,16,24,32,64,96,128].

Parameters:

RedisShardNum - Number of shards in an instance. This parameter is required for instances in cluster architecture. Value range: [3,5,8,12,16,24,32,64,96,128].

getRedisReplicasNum

public Long getRedisReplicasNum()

Get Number of replicas in an instance. Redis 2.8 standard edition and CKV standard edition support 1 replica. Standard/cluster edition 4.0 and 5.0 support 1-5 replicas.

Returns:

RedisReplicasNum Number of replicas in an instance. Redis 2.8 standard edition and CKV standard edition support 1 replica. Standard/cluster edition 4.0 and 5.0 support 1-5 replicas.

setRedisReplicasNum

public void setRedisReplicasNum(Long RedisReplicasNum)

Set Number of replicas in an instance. Redis 2.8 standard edition and CKV standard edition support 1 replica. Standard/cluster edition 4.0 and 5.0 support 1-5 replicas.

Parameters:

RedisReplicasNum - Number of replicas in an instance. Redis 2.8 standard edition and CKV standard edition support 1 replica. Standard/cluster edition 4.0 and 5.0 support 1-5 replicas.

getReplicasReadonly

public Boolean getReplicasReadonly()

Get Whether to support read-only replicas. Neither Redis 2.8 in standard architecture nor CKV in standard architecture supports read-only replicas. Read/write separation will be automatically enabled for an instance after it enables read-only replicas. Write requests will be directed to the master node and read requests will be distributed on the replica nodes. To enable read-only replicas, we recommend that you create 2 or more replicas.

Returns:

ReplicasReadonly Whether to support read-only replicas. Neither Redis 2.8 in standard architecture nor CKV in standard architecture supports read-only replicas. Read/write separation will be automatically enabled for an instance after it enables read-only replicas. Write requests will be directed to the master node and read requests will be distributed on the replica nodes. To enable read-only replicas, we recommend that you create 2 or more replicas.

setReplicasReadonly

public void setReplicasReadonly(Boolean ReplicasReadonly)

Set Whether to support read-only replicas. Neither Redis 2.8 in standard architecture nor CKV in standard architecture supports read-only replicas. Read/write separation will be automatically enabled for an instance after it enables read-only replicas. Write requests will be directed to the master node and read requests will be distributed on the replica nodes. To enable read-only replicas, we recommend that you create 2 or more replicas.

Parameters:

ReplicasReadonly - Whether to support read-only replicas. Neither Redis 2.8 in standard architecture nor CKV in standard architecture supports read-only replicas. Read/write separation will be automatically enabled for an instance after it enables read-only replicas. Write requests will be directed to the master node and read requests will be distributed on the replica nodes. To enable read-only replicas, we recommend that you create 2 or more replicas.

getInstanceName

public String getInstanceName()

Get Instance name. It contains only letters, digits, and symbols (-_) with a length of up to 60 characters.

Returns:

InstanceName Instance name. It contains only letters, digits, and symbols (-_) with a length of up to 60 characters.

setInstanceName

public void setInstanceName(String InstanceName)

Set Instance name. It contains only letters, digits, and symbols (-_) with a length of up to 60 characters.

Parameters:

InstanceName - Instance name. It contains only letters, digits, and symbols (-_) with a length of up to 60 characters.

getNoAuth

public Boolean getNoAuth()

Get Whether to support the password-free feature. Valid values: true (password-free instance), false (password-enabled instance). Default value: false. Only instances in a VPC support the password-free access.

Returns:

NoAuth Whether to support the password-free feature. Valid values: true (password-free instance), false (password-enabled instance). Default value: false. Only instances in a VPC support the password-free access.

setNoAuth

public void setNoAuth(Boolean NoAuth)

Set Whether to support the password-free feature. Valid values: true (password-free instance), false (password-enabled instance). Default value: false. Only instances in a VPC support the password-free access.

Parameters:

NoAuth - Whether to support the password-free feature. Valid values: true (password-free instance), false (password-enabled instance). Default value: false. Only instances in a VPC support the password-free access.

getNodeSet

public RedisNodeInfo[] getNodeSet()

Get Node information of an instance. Currently, information about the node type (master or replica) and node availability zone can be passed in. This parameter is not required for instances deployed in a single availability zone.

Returns:

NodeSet Node information of an instance. Currently, information about the node type (master or replica) and node availability zone can be passed in. This parameter is not required for instances deployed in a single availability zone.

setNodeSet

public void setNodeSet(RedisNodeInfo[] NodeSet)

Set Node information of an instance. Currently, information about the node type (master or replica) and node availability zone can be passed in. This parameter is not required for instances deployed in a single availability zone.

Parameters:

NodeSet - Node information of an instance. Currently, information about the node type (master or replica) and node availability zone can be passed in. This parameter is not required for instances deployed in a single availability zone.

getResourceTags

public ResourceTag[] getResourceTags()

Get The tag bound with the instance to be purchased

Returns:

ResourceTags The tag bound with the instance to be purchased

setResourceTags

public void setResourceTags(ResourceTag[] ResourceTags)

Set The tag bound with the instance to be purchased

Parameters:

ResourceTags - The tag bound with the instance to be purchased

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel