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 changes, in GB.
String	getMongosMemory() Get Memory size of the Mongos node after sharded cluster instance configuration changes, in GB.
Long	getNodeNum() Get Number of Mongod nodes after instance changes (excluding read-only nodes).
Long	getOplogSize() Deprecated.
RemoveNodeList[]	getRemoveNodeList() Get Deletes the node list.
Long	getReplicateSetNum() Get Number of shards after instance changes.
Long	getVolume() Get Hard disk size after instance configuration changes, in GB.
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 changes, in GB.
void	setMongosMemory(String MongosMemory) Set Memory size of the Mongos node after sharded cluster instance configuration changes, in GB.
void	setNodeNum(Long NodeNum) Set Number of Mongod nodes after instance changes (excluding read-only nodes).
void	setOplogSize(Long OplogSize) Deprecated.
void	setRemoveNodeList(RemoveNodeList[] RemoveNodeList) Set Deletes the node list.
void	setReplicateSetNum(Long ReplicateSetNum) Set Number of shards after instance changes.
void	setVolume(Long Volume) Set Hard disk size after instance configuration changes, in GB.
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. 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. 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. 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. 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 changes, in GB. If this parameter is left blank, the default value is the current memory size of the instance. For the currently supported memory specifications, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). Note**: Memory and disk configurations should be upgraded or downgraded simultaneously, meaning that Memory and Volume should be modified at the same time.

Returns:

Memory Memory size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current memory size of the instance. For the currently supported memory specifications, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). Note**: Memory and disk configurations should be upgraded or downgraded simultaneously, meaning that Memory and Volume should be modified at the same time.

setMemory

public void setMemory(Long Memory)

Set Memory size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current memory size of the instance. For the currently supported memory specifications, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). Note**: Memory and disk configurations should be upgraded or downgraded simultaneously, meaning that Memory and Volume should be modified at the same time.

Parameters:

Memory - Memory size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current memory size of the instance. For the currently supported memory specifications, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). Note**: Memory and disk configurations should be upgraded or downgraded simultaneously, meaning that Memory and Volume should be modified at the same time.

getVolume

public Long getVolume()

Get Hard disk size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current disk size of the instance. For the currently supported disk capacity, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). - 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 downgrade, the disk capacity after changes should be greater than 1.2 times the used disk capacity.

Returns:

Volume Hard disk size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current disk size of the instance. For the currently supported disk capacity, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). - 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 downgrade, the disk capacity after changes should be greater than 1.2 times the used disk capacity.

setVolume

public void setVolume(Long Volume)

Set Hard disk size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current disk size of the instance. For the currently supported disk capacity, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). - 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 downgrade, the disk capacity after changes should be greater than 1.2 times the used disk capacity.

Parameters:

Volume - Hard disk size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current disk size of the instance. For the currently supported disk capacity, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). - 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 downgrade, the disk capacity after changes 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 changes (excluding read-only nodes). - Number of replica set nodes. The value range of the number of nodes can be obtained through the response parameters MinNodeNum and MaxNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. - Number of nodes per shard in a sharded cluster. The value range of the number of nodes can be obtained through the response parameters MinReplicateSetNodeNum and MaxReplicateSetNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. Note**: When the CPU and memory specifications of Mongod or Mongos nodes are changed, this parameter is not required, or enter the current number of Mongod or Mongos nodes (excluding read-only nodes).

Returns:

NodeNum Number of Mongod nodes after instance changes (excluding read-only nodes). - Number of replica set nodes. The value range of the number of nodes can be obtained through the response parameters MinNodeNum and MaxNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. - Number of nodes per shard in a sharded cluster. The value range of the number of nodes can be obtained through the response parameters MinReplicateSetNodeNum and MaxReplicateSetNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. Note**: When the CPU and memory specifications of Mongod or Mongos nodes are changed, this parameter is not required, or enter the current number of Mongod or Mongos nodes (excluding read-only nodes).

setNodeNum

public void setNodeNum(Long NodeNum)

Set Number of Mongod nodes after instance changes (excluding read-only nodes). - Number of replica set nodes. The value range of the number of nodes can be obtained through the response parameters MinNodeNum and MaxNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. - Number of nodes per shard in a sharded cluster. The value range of the number of nodes can be obtained through the response parameters MinReplicateSetNodeNum and MaxReplicateSetNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. Note**: When the CPU and memory specifications of Mongod or Mongos nodes are changed, this parameter is not required, or enter the current number of Mongod or Mongos nodes (excluding read-only nodes).

Parameters:

NodeNum - Number of Mongod nodes after instance changes (excluding read-only nodes). - Number of replica set nodes. The value range of the number of nodes can be obtained through the response parameters MinNodeNum and MaxNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. - Number of nodes per shard in a sharded cluster. The value range of the number of nodes can be obtained through the response parameters MinReplicateSetNodeNum and MaxReplicateSetNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. Note**: When the CPU and memory specifications of Mongod or Mongos nodes are changed, this parameter is not required, or enter the current number of Mongod or Mongos nodes (excluding read-only nodes).

getReplicateSetNum

public Long getReplicateSetNum()

Get Number of shards after instance changes. - The value range for the number of instance shards can be obtained through the response parameters **MinReplicateSetNum** and **MaxReplicateSetNum** of the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. - The number of instance shards can only be increased and cannot be decreased.

Returns:

ReplicateSetNum Number of shards after instance changes. - The value range for the number of instance shards can be obtained through the response parameters **MinReplicateSetNum** and **MaxReplicateSetNum** of the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. - The number of instance shards can only be increased and cannot be decreased.

setReplicateSetNum

public void setReplicateSetNum(Long ReplicateSetNum)

Set Number of shards after instance changes. - The value range for the number of instance shards can be obtained through the response parameters **MinReplicateSetNum** and **MaxReplicateSetNum** of the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. - The number of instance shards can only be increased and cannot be decreased.

Parameters:

ReplicateSetNum - Number of shards after instance changes. - The value range for the number of instance shards can be obtained through the response parameters **MinReplicateSetNum** and **MaxReplicateSetNum** of the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. - The number of instance shards can only be increased and cannot be 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 Memory size of the Mongos node after sharded cluster instance configuration changes, in GB. For the specifications supported by the instance, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1).

Returns:

MongosMemory Memory size of the Mongos node after sharded cluster instance configuration changes, in GB. For the specifications supported by the instance, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1).

setMongosMemory

public void setMongosMemory(String MongosMemory)

Set Memory size of the Mongos node after sharded cluster instance configuration changes, in GB. For the specifications supported by the instance, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1).

Parameters:

MongosMemory - Memory size of the Mongos node after sharded cluster instance configuration changes, in GB. For the specifications supported by the instance, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1).

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 Deletes the node list. 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 Deletes the node list. 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 Deletes the node list. 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 - Deletes the node list. 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.