com.tencentcloudapi.mongodb.v20190725.models

Class ModifyDBInstanceSpecRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mongodb.v20190725.models.ModifyDBInstanceSpecRequest

public class ModifyDBInstanceSpecRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ModifyDBInstanceSpecRequest()
ModifyDBInstanceSpecRequest(ModifyDBInstanceSpecRequest 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
AddNodeList[]	getAddNodeList() Get List of nodes to be added, containing the node type and AZ information.
Long	getInMaintenance() Get Switch time for instance configuration modification.
String	getInstanceId() Get Instance ID.
Long	getMemory() Get Memory size after instance configuration modification.
String	getMongosMemory() Get Mongos node memory size after the sharded cluster instance configuration is modified.
Long	getNodeNum() Get Number of Mongod nodes after instance modification (excluding read-only nodes).
Long	getOplogSize() Deprecated.
RemoveNodeList[]	getRemoveNodeList() Get List of nodes to be deleted.
Long	getReplicateSetNum() Get Number of shards after instance modification.
Long	getVolume() Get Disk capacity after instance configuration modification.
void	setAddNodeList(AddNodeList[] AddNodeList) Set List of nodes to be added, containing the node type and AZ information.
void	setInMaintenance(Long InMaintenance) Set Switch time for instance configuration modification.
void	setInstanceId(String InstanceId) Set Instance ID.
void	setMemory(Long Memory) Set Memory size after instance configuration modification.
void	setMongosMemory(String MongosMemory) Set Mongos node memory size after the sharded cluster instance configuration is modified.
void	setNodeNum(Long NodeNum) Set Number of Mongod nodes after instance modification (excluding read-only nodes).
void	setOplogSize(Long OplogSize) Deprecated.
void	setRemoveNodeList(RemoveNodeList[] RemoveNodeList) Set List of nodes to be deleted.
void	setReplicateSetNum(Long ReplicateSetNum) Set Number of shards after instance modification.
void	setVolume(Long Volume) Set Disk capacity after instance configuration modification.
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

ModifyDBInstanceSpecRequest

public ModifyDBInstanceSpecRequest()

ModifyDBInstanceSpecRequest

public ModifyDBInstanceSpecRequest(ModifyDBInstanceSpecRequest 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. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.

Returns:

InstanceId Instance ID. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.

setInstanceId

public void setInstanceId(String InstanceId)

Set Instance ID. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.

Parameters:

InstanceId - Instance ID. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.

getMemory

public Long getMemory()

Get Memory size after instance configuration modification. - Unit: GB. The current instance memory size is used by default if this parameter is left blank.
Note: Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time.

Returns:

Memory Memory size after instance configuration modification. - Unit: GB. The current instance memory size is used by default if this parameter is left blank.
Note: Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time.

setMemory

public void setMemory(Long Memory)

Set Memory size after instance configuration modification. - Unit: GB. The current instance memory size is used by default if this parameter is left blank.
Note: Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time.

Parameters:

Memory - Memory size after instance configuration modification. - Unit: GB. The current instance memory size is used by default if this parameter is left blank.
Note: Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time.

getVolume

public Long getVolume()

Get Disk capacity after instance configuration modification. Unit: GB. The current instance disk capacity is used by default if this parameter is left blank. - Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time. - During configuration downgrading, the disk capacity after modification should be greater than 1.2 times the used disk capacity.

Returns:

Volume Disk capacity after instance configuration modification. Unit: GB. The current instance disk capacity is used by default if this parameter is left blank. - Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time. - During configuration downgrading, the disk capacity after modification should be greater than 1.2 times the used disk capacity.

setVolume

public void setVolume(Long Volume)

Set Disk capacity after instance configuration modification. Unit: GB. The current instance disk capacity is used by default if this parameter is left blank. - Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time. - During configuration downgrading, the disk capacity after modification should be greater than 1.2 times the used disk capacity.

Parameters:

Volume - Disk capacity after instance configuration modification. Unit: GB. The current instance disk capacity is used by default if this parameter is left blank. - Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time. - During configuration downgrading, the disk capacity after modification should be greater than 1.2 times the used disk capacity.

getOplogSize

@Deprecated
public Long getOplogSize()

Deprecated.

Get (Deprecated) Use the independent API ResizeOplog. Oplog size after instance configuration modification. - Unit: GB. - By default, the capacity occupied by Oplog is 10% of the disk capacity. The range of capacity occupied by Oplog supported by the system is [10%,90%] of the disk capacity.

Returns:

OplogSize (Deprecated) Use the independent API ResizeOplog. Oplog size after instance configuration modification. - Unit: GB. - By default, the capacity occupied by Oplog is 10% of the disk capacity. The range of capacity occupied by Oplog supported by the system is [10%,90%] of the disk capacity.

setOplogSize

@Deprecated
public void setOplogSize(Long OplogSize)

Deprecated.

Set (Deprecated) Use the independent API ResizeOplog. Oplog size after instance configuration modification. - Unit: GB. - By default, the capacity occupied by Oplog is 10% of the disk capacity. The range of capacity occupied by Oplog supported by the system is [10%,90%] of the disk capacity.

Parameters:

OplogSize - (Deprecated) Use the independent API ResizeOplog. Oplog size after instance configuration modification. - Unit: GB. - By default, the capacity occupied by Oplog is 10% of the disk capacity. The range of capacity occupied by Oplog supported by the system is [10%,90%] of the disk capacity.

getNodeNum

public Long getNodeNum()

Get Number of Mongod nodes after instance modification (excluding read-only nodes). - When the CPU and memory specifications of Mongod nodes are modified, this parameter can be left blank or set to the current number of Mongod nodes (excluding read-only nodes). - When the CPU and memory specifications of Mongos nodes are modified, this parameter can be left blank or set to the current number of Mongod nodes (excluding read-only nodes). - During node modification (all types), this parameter can be left blank or set to the number of Mongod nodes (excluding read-only nodes) after modification. - Number of replica set nodes: Confirm the range of the number of nodes based on the MinNodeNum and MaxNodeNum parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38565?from_cn_redirect=1) API for querying saleable TencenDB for MongoDB specifications. - Number of nodes for each shard in a sharded cluster: Confirm the range of the number of nodes based on the MinReplicateSetNodeNum and MaxReplicateSetNodeNum parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38565?from_cn_redirect=1) API for querying saleable TencenDB for MongoDB specifications.

Returns:

NodeNum Number of Mongod nodes after instance modification (excluding read-only nodes). - When the CPU and memory specifications of Mongod nodes are modified, this parameter can be left blank or set to the current number of Mongod nodes (excluding read-only nodes). - When the CPU and memory specifications of Mongos nodes are modified, this parameter can be left blank or set to the current number of Mongod nodes (excluding read-only nodes). - During node modification (all types), this parameter can be left blank or set to the number of Mongod nodes (excluding read-only nodes) after modification. - Number of replica set nodes: Confirm the range of the number of nodes based on the MinNodeNum and MaxNodeNum parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38565?from_cn_redirect=1) API for querying saleable TencenDB for MongoDB specifications. - Number of nodes for each shard in a sharded cluster: Confirm the range of the number of nodes based on the MinReplicateSetNodeNum and MaxReplicateSetNodeNum parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38565?from_cn_redirect=1) API for querying saleable TencenDB for MongoDB specifications.

setNodeNum

public void setNodeNum(Long NodeNum)

Set Number of Mongod nodes after instance modification (excluding read-only nodes). - When the CPU and memory specifications of Mongod nodes are modified, this parameter can be left blank or set to the current number of Mongod nodes (excluding read-only nodes). - When the CPU and memory specifications of Mongos nodes are modified, this parameter can be left blank or set to the current number of Mongod nodes (excluding read-only nodes). - During node modification (all types), this parameter can be left blank or set to the number of Mongod nodes (excluding read-only nodes) after modification. - Number of replica set nodes: Confirm the range of the number of nodes based on the MinNodeNum and MaxNodeNum parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38565?from_cn_redirect=1) API for querying saleable TencenDB for MongoDB specifications. - Number of nodes for each shard in a sharded cluster: Confirm the range of the number of nodes based on the MinReplicateSetNodeNum and MaxReplicateSetNodeNum parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38565?from_cn_redirect=1) API for querying saleable TencenDB for MongoDB specifications.

Parameters:

NodeNum - Number of Mongod nodes after instance modification (excluding read-only nodes). - When the CPU and memory specifications of Mongod nodes are modified, this parameter can be left blank or set to the current number of Mongod nodes (excluding read-only nodes). - When the CPU and memory specifications of Mongos nodes are modified, this parameter can be left blank or set to the current number of Mongod nodes (excluding read-only nodes). - During node modification (all types), this parameter can be left blank or set to the number of Mongod nodes (excluding read-only nodes) after modification. - Number of replica set nodes: Confirm the range of the number of nodes based on the MinNodeNum and MaxNodeNum parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38565?from_cn_redirect=1) API for querying saleable TencenDB for MongoDB specifications. - Number of nodes for each shard in a sharded cluster: Confirm the range of the number of nodes based on the MinReplicateSetNodeNum and MaxReplicateSetNodeNum parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38565?from_cn_redirect=1) API for querying saleable TencenDB for MongoDB specifications.

getReplicateSetNum

public Long getReplicateSetNum()

Get Number of shards after instance modification. - The value range can be obtained from the **MinReplicateSetNum** and **MaxReplicateSetNum** parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API for querying saleable TencentDB for MongoDB specifications. - The value of this parameter can only be increased but not decreased.

Returns:

ReplicateSetNum Number of shards after instance modification. - The value range can be obtained from the **MinReplicateSetNum** and **MaxReplicateSetNum** parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API for querying saleable TencentDB for MongoDB specifications. - The value of this parameter can only be increased but not decreased.

setReplicateSetNum

public void setReplicateSetNum(Long ReplicateSetNum)

Set Number of shards after instance modification. - The value range can be obtained from the **MinReplicateSetNum** and **MaxReplicateSetNum** parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API for querying saleable TencentDB for MongoDB specifications. - The value of this parameter can only be increased but not decreased.

Parameters:

ReplicateSetNum - Number of shards after instance modification. - The value range can be obtained from the **MinReplicateSetNum** and **MaxReplicateSetNum** parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API for querying saleable TencentDB for MongoDB specifications. - The value of this parameter can only be increased but not decreased.

getInMaintenance

public Long getInMaintenance()

Get Switch time for instance configuration modification. - 0: Execute the configuration modification task immediately after the adjustment is completed. Default value: 0. - 1: Execute the configuration modification task within the maintenance window. Note**: Adjusting the number of nodes and shards is unsupported within the maintenance window.

Returns:

InMaintenance Switch time for instance configuration modification. - 0: Execute the configuration modification task immediately after the adjustment is completed. Default value: 0. - 1: Execute the configuration modification task within the maintenance window. Note**: Adjusting the number of nodes and shards is unsupported within the maintenance window.

setInMaintenance

public void setInMaintenance(Long InMaintenance)

Set Switch time for instance configuration modification. - 0: Execute the configuration modification task immediately after the adjustment is completed. Default value: 0. - 1: Execute the configuration modification task within the maintenance window. Note**: Adjusting the number of nodes and shards is unsupported within the maintenance window.

Parameters:

InMaintenance - Switch time for instance configuration modification. - 0: Execute the configuration modification task immediately after the adjustment is completed. Default value: 0. - 1: Execute the configuration modification task within the maintenance window. Note**: Adjusting the number of nodes and shards is unsupported within the maintenance window.

getMongosMemory

public String getMongosMemory()

Get Mongos node memory size after the sharded cluster instance configuration is modified. Unit: GB.

Returns:

MongosMemory Mongos node memory size after the sharded cluster instance configuration is modified. Unit: GB.

setMongosMemory

public void setMongosMemory(String MongosMemory)

Set Mongos node memory size after the sharded cluster instance configuration is modified. Unit: GB.

Parameters:

MongosMemory - Mongos node memory size after the sharded cluster instance configuration is modified. Unit: GB.

getAddNodeList

public AddNodeList[] getAddNodeList()

Get List of nodes to be added, containing the node type and AZ information.

Returns:

AddNodeList List of nodes to be added, containing the node type and AZ information.

setAddNodeList

public void setAddNodeList(AddNodeList[] AddNodeList)

Set List of nodes to be added, containing the node type and AZ information.

Parameters:

AddNodeList - List of nodes to be added, containing the node type and AZ information.

getRemoveNodeList

public RemoveNodeList[] getRemoveNodeList()

Get List of nodes to be deleted. Note: According to the consistency principle for nodes of each shard on a sharded cluster instance, specify the nodes on shard 0 for node deletion from the sharded cluster instance. For example, cmgo-9nl1czif_0-node-readonly0 will delete the first read-only node of each shard.

Returns:

RemoveNodeList List of nodes to be deleted. Note: According to the consistency principle for nodes of each shard on a sharded cluster instance, specify the nodes on shard 0 for node deletion from the sharded cluster instance. For example, cmgo-9nl1czif_0-node-readonly0 will delete the first read-only node of each shard.

setRemoveNodeList

public void setRemoveNodeList(RemoveNodeList[] RemoveNodeList)

Set List of nodes to be deleted. Note: According to the consistency principle for nodes of each shard on a sharded cluster instance, specify the nodes on shard 0 for node deletion from the sharded cluster instance. For example, cmgo-9nl1czif_0-node-readonly0 will delete the first read-only node of each shard.

Parameters:

RemoveNodeList - List of nodes to be deleted. Note: According to the consistency principle for nodes of each shard on a sharded cluster instance, specify the nodes on shard 0 for node deletion from the sharded cluster instance. For example, cmgo-9nl1czif_0-node-readonly0 will delete the first read-only node of each shard.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.