com.tencentcloudapi.sqlserver.v20180328.models

Class CreateCloudReadOnlyDBInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.sqlserver.v20180328.models.CreateCloudReadOnlyDBInstancesRequest

public class CreateCloudReadOnlyDBInstancesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateCloudReadOnlyDBInstancesRequest()
CreateCloudReadOnlyDBInstancesRequest(CreateCloudReadOnlyDBInstancesRequest 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 Whether to automatically use voucher.
String	getCollation() Get Collation of system character sets.
Long	getCpu() Get Number of instance cores
Long	getGoodsNum() Get Number of read-only instances to be purchased this time.
String	getInstanceChargeType() Get Billing mode.
String	getInstanceId() Get Instance ID in the format of `mssql-3l3fgqn7`.
String	getMachineType() Get The host type of purchased instance.
Long	getMemory() Get Instance memory size in GB
Long	getPeriod() Get The purchase period of an instance.
Long	getReadOnlyGroupForcedUpgrade() Get Valid values: `0` (not upgrade the primary instance by default), `1` (upgrade the primary instance to complete the RO deployment).
String	getReadOnlyGroupId() Get Existing read-only group ID, which is required when `ReadOnlyGroupType` is `3`.
Long	getReadOnlyGroupIsOfflineDelay() Get Whether delayed read-only instance removal is enabled in a new read-only group, which is required when `ReadOnlyGroupType` is `2`.
Long	getReadOnlyGroupMaxDelayTime() Get The delay threshold for a new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.
Long	getReadOnlyGroupMinInGroup() Get Minimum number of reserved read-only replicas when the delayed removal is enabled for the new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.
String	getReadOnlyGroupName() Get New read-only group ID, which is required when `ReadOnlyGroupType` is `2`.
Long	getReadOnlyGroupType() Get Read-only group types.
ResourceTag[]	getResourceTags() Get Tags associated with the instances to be created
String[]	getSecurityGroupList() Get Security group list, which contains security group IDs in the format of `sg-xxx`.
Long	getStorage() Get Instance disk size in GB
String	getSubnetId() Get VPC subnet ID in the format of `subnet-bdoe83fa`.
String	getTimeZone() Get System time zone.
String[]	getVoucherIds() Get Array of voucher IDs (currently, only one voucher can be used per order)
String	getVpcId() Get VPC ID in the format of `vpc-dsp338hz`.
String	getZone() Get Instance AZ, such as `ap-guangzhou-1` (Guangzhou Zone 1).
void	setAutoVoucher(Long AutoVoucher) Set Whether to automatically use voucher.
void	setCollation(String Collation) Set Collation of system character sets.
void	setCpu(Long Cpu) Set Number of instance cores
void	setGoodsNum(Long GoodsNum) Set Number of read-only instances to be purchased this time.
void	setInstanceChargeType(String InstanceChargeType) Set Billing mode.
void	setInstanceId(String InstanceId) Set Instance ID in the format of `mssql-3l3fgqn7`.
void	setMachineType(String MachineType) Set The host type of purchased instance.
void	setMemory(Long Memory) Set Instance memory size in GB
void	setPeriod(Long Period) Set The purchase period of an instance.
void	setReadOnlyGroupForcedUpgrade(Long ReadOnlyGroupForcedUpgrade) Set Valid values: `0` (not upgrade the primary instance by default), `1` (upgrade the primary instance to complete the RO deployment).
void	setReadOnlyGroupId(String ReadOnlyGroupId) Set Existing read-only group ID, which is required when `ReadOnlyGroupType` is `3`.
void	setReadOnlyGroupIsOfflineDelay(Long ReadOnlyGroupIsOfflineDelay) Set Whether delayed read-only instance removal is enabled in a new read-only group, which is required when `ReadOnlyGroupType` is `2`.
void	setReadOnlyGroupMaxDelayTime(Long ReadOnlyGroupMaxDelayTime) Set The delay threshold for a new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.
void	setReadOnlyGroupMinInGroup(Long ReadOnlyGroupMinInGroup) Set Minimum number of reserved read-only replicas when the delayed removal is enabled for the new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.
void	setReadOnlyGroupName(String ReadOnlyGroupName) Set New read-only group ID, which is required when `ReadOnlyGroupType` is `2`.
void	setReadOnlyGroupType(Long ReadOnlyGroupType) Set Read-only group types.
void	setResourceTags(ResourceTag[] ResourceTags) Set Tags associated with the instances to be created
void	setSecurityGroupList(String[] SecurityGroupList) Set Security group list, which contains security group IDs in the format of `sg-xxx`.
void	setStorage(Long Storage) Set Instance disk size in GB
void	setSubnetId(String SubnetId) Set VPC subnet ID in the format of `subnet-bdoe83fa`.
void	setTimeZone(String TimeZone) Set System time zone.
void	setVoucherIds(String[] VoucherIds) Set Array of voucher IDs (currently, only one voucher can be used per order)
void	setVpcId(String VpcId) Set VPC ID in the format of `vpc-dsp338hz`.
void	setZone(String Zone) Set Instance AZ, such as `ap-guangzhou-1` (Guangzhou Zone 1).
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

CreateCloudReadOnlyDBInstancesRequest

public CreateCloudReadOnlyDBInstancesRequest()

CreateCloudReadOnlyDBInstancesRequest

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

getInstanceId

public String getInstanceId()

Get Instance ID in the format of `mssql-3l3fgqn7`.

Returns:

InstanceId Instance ID in the format of `mssql-3l3fgqn7`.

setInstanceId

public void setInstanceId(String InstanceId)

Set Instance ID in the format of `mssql-3l3fgqn7`.

Parameters:

InstanceId - Instance ID in the format of `mssql-3l3fgqn7`.

getZone

public String getZone()

Get Instance AZ, such as `ap-guangzhou-1` (Guangzhou Zone 1). Purchasable AZs for an instance can be obtained through the`DescribeZones` API.

Returns:

Zone Instance AZ, such as `ap-guangzhou-1` (Guangzhou Zone 1). Purchasable AZs for an instance can be obtained through the`DescribeZones` API.

setZone

public void setZone(String Zone)

Set Instance AZ, such as `ap-guangzhou-1` (Guangzhou Zone 1). Purchasable AZs for an instance can be obtained through the`DescribeZones` API.

Parameters:

Zone - Instance AZ, such as `ap-guangzhou-1` (Guangzhou Zone 1). Purchasable AZs for an instance can be obtained through the`DescribeZones` API.

getReadOnlyGroupType

public Long getReadOnlyGroupType()

Get Read-only group types. Valid values: `1` (each read-only replica is placed in one auto-created read-only group), `2` (all read-only replicas are placed in one auto-created read-only group), `3` (all read-only replicas are placed in one existing read-only group).

Returns:

ReadOnlyGroupType Read-only group types. Valid values: `1` (each read-only replica is placed in one auto-created read-only group), `2` (all read-only replicas are placed in one auto-created read-only group), `3` (all read-only replicas are placed in one existing read-only group).

setReadOnlyGroupType

public void setReadOnlyGroupType(Long ReadOnlyGroupType)

Set Read-only group types. Valid values: `1` (each read-only replica is placed in one auto-created read-only group), `2` (all read-only replicas are placed in one auto-created read-only group), `3` (all read-only replicas are placed in one existing read-only group).

Parameters:

ReadOnlyGroupType - Read-only group types. Valid values: `1` (each read-only replica is placed in one auto-created read-only group), `2` (all read-only replicas are placed in one auto-created read-only group), `3` (all read-only replicas are placed in one existing read-only group).

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

getStorage

public Long getStorage()

Get Instance disk size in GB

Returns:

Storage Instance disk size in GB

setStorage

public void setStorage(Long Storage)

Set Instance disk size in GB

Parameters:

Storage - Instance disk size in GB

getCpu

public Long getCpu()

Get Number of instance cores

Returns:

Cpu Number of instance cores

setCpu

public void setCpu(Long Cpu)

Set Number of instance cores

Parameters:

Cpu - Number of instance cores

getMachineType

public String getMachineType()

Get The host type of purchased instance. Valid values: `CLOUD_HSSD` (virtual machine with enhanced SSD), `CLOUD_TSSD` (virtual machine with ulTra SSD), `CLOUD_BSSD` (virtual machine with balanced SSD).

Returns:

MachineType The host type of purchased instance. Valid values: `CLOUD_HSSD` (virtual machine with enhanced SSD), `CLOUD_TSSD` (virtual machine with ulTra SSD), `CLOUD_BSSD` (virtual machine with balanced SSD).

setMachineType

public void setMachineType(String MachineType)

Set The host type of purchased instance. Valid values: `CLOUD_HSSD` (virtual machine with enhanced SSD), `CLOUD_TSSD` (virtual machine with ulTra SSD), `CLOUD_BSSD` (virtual machine with balanced SSD).

Parameters:

MachineType - The host type of purchased instance. Valid values: `CLOUD_HSSD` (virtual machine with enhanced SSD), `CLOUD_TSSD` (virtual machine with ulTra SSD), `CLOUD_BSSD` (virtual machine with balanced SSD).

getReadOnlyGroupForcedUpgrade

public Long getReadOnlyGroupForcedUpgrade()

Get Valid values: `0` (not upgrade the primary instance by default), `1` (upgrade the primary instance to complete the RO deployment). You need to pass in `1` for this parameter and upgrade the primary instance to cluster edition.

Returns:

ReadOnlyGroupForcedUpgrade Valid values: `0` (not upgrade the primary instance by default), `1` (upgrade the primary instance to complete the RO deployment). You need to pass in `1` for this parameter and upgrade the primary instance to cluster edition.

setReadOnlyGroupForcedUpgrade

public void setReadOnlyGroupForcedUpgrade(Long ReadOnlyGroupForcedUpgrade)

Set Valid values: `0` (not upgrade the primary instance by default), `1` (upgrade the primary instance to complete the RO deployment). You need to pass in `1` for this parameter and upgrade the primary instance to cluster edition.

Parameters:

ReadOnlyGroupForcedUpgrade - Valid values: `0` (not upgrade the primary instance by default), `1` (upgrade the primary instance to complete the RO deployment). You need to pass in `1` for this parameter and upgrade the primary instance to cluster edition.

getReadOnlyGroupId

public String getReadOnlyGroupId()

Get Existing read-only group ID, which is required when `ReadOnlyGroupType` is `3`.

Returns:

ReadOnlyGroupId Existing read-only group ID, which is required when `ReadOnlyGroupType` is `3`.

setReadOnlyGroupId

public void setReadOnlyGroupId(String ReadOnlyGroupId)

Set Existing read-only group ID, which is required when `ReadOnlyGroupType` is `3`.

Parameters:

ReadOnlyGroupId - Existing read-only group ID, which is required when `ReadOnlyGroupType` is `3`.

getReadOnlyGroupName

public String getReadOnlyGroupName()

Get New read-only group ID, which is required when `ReadOnlyGroupType` is `2`.

Returns:

ReadOnlyGroupName New read-only group ID, which is required when `ReadOnlyGroupType` is `2`.

setReadOnlyGroupName

public void setReadOnlyGroupName(String ReadOnlyGroupName)

Set New read-only group ID, which is required when `ReadOnlyGroupType` is `2`.

Parameters:

ReadOnlyGroupName - New read-only group ID, which is required when `ReadOnlyGroupType` is `2`.

getReadOnlyGroupIsOfflineDelay

public Long getReadOnlyGroupIsOfflineDelay()

Get Whether delayed read-only instance removal is enabled in a new read-only group, which is required when `ReadOnlyGroupType` is `2`. Valid values: `1` (enabled), `0` (disabled). The read-only replica will be automatically removed when the delay between it and the primary instance exceeds the threshold.

Returns:

ReadOnlyGroupIsOfflineDelay Whether delayed read-only instance removal is enabled in a new read-only group, which is required when `ReadOnlyGroupType` is `2`. Valid values: `1` (enabled), `0` (disabled). The read-only replica will be automatically removed when the delay between it and the primary instance exceeds the threshold.

setReadOnlyGroupIsOfflineDelay

public void setReadOnlyGroupIsOfflineDelay(Long ReadOnlyGroupIsOfflineDelay)

Set Whether delayed read-only instance removal is enabled in a new read-only group, which is required when `ReadOnlyGroupType` is `2`. Valid values: `1` (enabled), `0` (disabled). The read-only replica will be automatically removed when the delay between it and the primary instance exceeds the threshold.

Parameters:

ReadOnlyGroupIsOfflineDelay - Whether delayed read-only instance removal is enabled in a new read-only group, which is required when `ReadOnlyGroupType` is `2`. Valid values: `1` (enabled), `0` (disabled). The read-only replica will be automatically removed when the delay between it and the primary instance exceeds the threshold.

getReadOnlyGroupMaxDelayTime

public Long getReadOnlyGroupMaxDelayTime()

Get The delay threshold for a new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.

Returns:

ReadOnlyGroupMaxDelayTime The delay threshold for a new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.

setReadOnlyGroupMaxDelayTime

public void setReadOnlyGroupMaxDelayTime(Long ReadOnlyGroupMaxDelayTime)

Set The delay threshold for a new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.

Parameters:

ReadOnlyGroupMaxDelayTime - The delay threshold for a new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.

getReadOnlyGroupMinInGroup

public Long getReadOnlyGroupMinInGroup()

Get Minimum number of reserved read-only replicas when the delayed removal is enabled for the new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.

Returns:

ReadOnlyGroupMinInGroup Minimum number of reserved read-only replicas when the delayed removal is enabled for the new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.

setReadOnlyGroupMinInGroup

public void setReadOnlyGroupMinInGroup(Long ReadOnlyGroupMinInGroup)

Set Minimum number of reserved read-only replicas when the delayed removal is enabled for the new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.

Parameters:

ReadOnlyGroupMinInGroup - Minimum number of reserved read-only replicas when the delayed removal is enabled for the new read-only group, which is required when `ReadOnlyGroupType` is `2` and `ReadOnlyGroupIsOfflineDelay` is `1`.

getInstanceChargeType

public String getInstanceChargeType()

Get Billing mode. Valid values: `PREPAID` (monthly subscription), `POSTPAID` (pay-as-you-go).

Returns:

InstanceChargeType Billing mode. Valid values: `PREPAID` (monthly subscription), `POSTPAID` (pay-as-you-go).

setInstanceChargeType

public void setInstanceChargeType(String InstanceChargeType)

Set Billing mode. Valid values: `PREPAID` (monthly subscription), `POSTPAID` (pay-as-you-go).

Parameters:

InstanceChargeType - Billing mode. Valid values: `PREPAID` (monthly subscription), `POSTPAID` (pay-as-you-go).

getGoodsNum

public Long getGoodsNum()

Get Number of read-only instances to be purchased this time. Default value: `2`.

Returns:

GoodsNum Number of read-only instances to be purchased this time. Default value: `2`.

setGoodsNum

public void setGoodsNum(Long GoodsNum)

Set Number of read-only instances to be purchased this time. Default value: `2`.

Parameters:

GoodsNum - Number of read-only instances to be purchased this time. Default value: `2`.

getSubnetId

public String getSubnetId()

Get VPC subnet ID in the format of `subnet-bdoe83fa`. Both `SubnetId` and `VpcId` need to be set or unset at the same time.

Returns:

SubnetId VPC subnet ID in the format of `subnet-bdoe83fa`. Both `SubnetId` and `VpcId` need to be set or unset at the same time.

setSubnetId

public void setSubnetId(String SubnetId)

Set VPC subnet ID in the format of `subnet-bdoe83fa`. Both `SubnetId` and `VpcId` need to be set or unset at the same time.

Parameters:

SubnetId - VPC subnet ID in the format of `subnet-bdoe83fa`. Both `SubnetId` and `VpcId` need to be set or unset at the same time.

getVpcId

public String getVpcId()

Get VPC ID in the format of `vpc-dsp338hz`. Both `SubnetId` and `VpcId` need to be set or unset at the same time.

Returns:

VpcId VPC ID in the format of `vpc-dsp338hz`. Both `SubnetId` and `VpcId` need to be set or unset at the same time.

setVpcId

public void setVpcId(String VpcId)

Set VPC ID in the format of `vpc-dsp338hz`. Both `SubnetId` and `VpcId` need to be set or unset at the same time.

Parameters:

VpcId - VPC ID in the format of `vpc-dsp338hz`. Both `SubnetId` and `VpcId` need to be set or unset at the same time.

getPeriod

public Long getPeriod()

Get The purchase period of an instance. Default value: `1` (one month). Maximum value: `48`.

Returns:

Period The purchase period of an instance. Default value: `1` (one month). Maximum value: `48`.

setPeriod

public void setPeriod(Long Period)

Set The purchase period of an instance. Default value: `1` (one month). Maximum value: `48`.

Parameters:

Period - The purchase period of an instance. Default value: `1` (one month). Maximum value: `48`.

getSecurityGroupList

public String[] getSecurityGroupList()

Get Security group list, which contains security group IDs in the format of `sg-xxx`.

Returns:

SecurityGroupList Security group list, which contains security group IDs in the format of `sg-xxx`.

setSecurityGroupList

public void setSecurityGroupList(String[] SecurityGroupList)

Set Security group list, which contains security group IDs in the format of `sg-xxx`.

Parameters:

SecurityGroupList - Security group list, which contains security group IDs in the format of `sg-xxx`.

getAutoVoucher

public Long getAutoVoucher()

Get Whether to automatically use voucher. Valid values: `0` (no, default), `1` (yes).

Returns:

AutoVoucher Whether to automatically use voucher. Valid values: `0` (no, default), `1` (yes).

setAutoVoucher

public void setAutoVoucher(Long AutoVoucher)

Set Whether to automatically use voucher. Valid values: `0` (no, default), `1` (yes).

Parameters:

AutoVoucher - Whether to automatically use voucher. Valid values: `0` (no, default), `1` (yes).

getVoucherIds

public String[] getVoucherIds()

Get Array of voucher IDs (currently, only one voucher can be used per order)

Returns:

VoucherIds Array of voucher IDs (currently, only one voucher can be used per order)

setVoucherIds

public void setVoucherIds(String[] VoucherIds)

Set Array of voucher IDs (currently, only one voucher can be used per order)

Parameters:

VoucherIds - Array of voucher IDs (currently, only one voucher can be used per order)

getResourceTags

public ResourceTag[] getResourceTags()

Get Tags associated with the instances to be created

Returns:

ResourceTags Tags associated with the instances to be created

setResourceTags

public void setResourceTags(ResourceTag[] ResourceTags)

Set Tags associated with the instances to be created

Parameters:

ResourceTags - Tags associated with the instances to be created

getCollation

public String getCollation()

Get Collation of system character sets. Default value: Chinese_PRC_CI_AS

Returns:

Collation Collation of system character sets. Default value: Chinese_PRC_CI_AS

setCollation

public void setCollation(String Collation)

Set Collation of system character sets. Default value: Chinese_PRC_CI_AS

Parameters:

Collation - Collation of system character sets. Default value: Chinese_PRC_CI_AS

getTimeZone

public String getTimeZone()

Get System time zone. Default value: `China Standard Time`

Returns:

TimeZone System time zone. Default value: `China Standard Time`

setTimeZone

public void setTimeZone(String TimeZone)

Set System time zone. Default value: `China Standard Time`

Parameters:

TimeZone - System time zone. Default value: `China Standard Time`

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel