com.tencentcloudapi.mongodb.v20190725.models

Class CreateBackupDownloadTaskRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mongodb.v20190725.models.CreateBackupDownloadTaskRequest

public class CreateBackupDownloadTaskRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateBackupDownloadTaskRequest()
CreateBackupDownloadTaskRequest(CreateBackupDownloadTaskRequest 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
String	getBackupName() Get The name of the backup file to be downloaded, which can be obtained by the `DescribeDBBackups` API.
ReplicaSetInfo[]	getBackupSets() Get Specify the node name of a replica set instance or the shard name list of a sharded cluster instance.
String	getInstanceId() Get Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console.
void	setBackupName(String BackupName) Set The name of the backup file to be downloaded, which can be obtained by the `DescribeDBBackups` API.
void	setBackupSets(ReplicaSetInfo[] BackupSets) Set Specify the node name of a replica set instance or the shard name list of a sharded cluster instance.
void	setInstanceId(String InstanceId) Set Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console.
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

CreateBackupDownloadTaskRequest

public CreateBackupDownloadTaskRequest()

CreateBackupDownloadTaskRequest

public CreateBackupDownloadTaskRequest(CreateBackupDownloadTaskRequest 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 "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console.

Returns:

InstanceId Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console.

setInstanceId

public void setInstanceId(String InstanceId)

Set Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console.

Parameters:

InstanceId - Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console.

getBackupName

public String getBackupName()

Get The name of the backup file to be downloaded, which can be obtained by the `DescribeDBBackups` API.

Returns:

BackupName The name of the backup file to be downloaded, which can be obtained by the `DescribeDBBackups` API.

setBackupName

public void setBackupName(String BackupName)

Set The name of the backup file to be downloaded, which can be obtained by the `DescribeDBBackups` API.

Parameters:

BackupName - The name of the backup file to be downloaded, which can be obtained by the `DescribeDBBackups` API.

getBackupSets

public ReplicaSetInfo[] getBackupSets()

Get Specify the node name of a replica set instance or the shard name list of a sharded cluster instance. Only backups of the specified node or shards will be downloaded. Suppose you have a replica set instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0` to download the full backup. For a replica set instance, the parameter value must be in the format of "instance ID_0". Suppose you have a sharded cluster instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1` to download the backup data of shard 0 and shard 1. To download the full backup, please specify all shard names.

Returns:

BackupSets Specify the node name of a replica set instance or the shard name list of a sharded cluster instance. Only backups of the specified node or shards will be downloaded. Suppose you have a replica set instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0` to download the full backup. For a replica set instance, the parameter value must be in the format of "instance ID_0". Suppose you have a sharded cluster instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1` to download the backup data of shard 0 and shard 1. To download the full backup, please specify all shard names.

setBackupSets

public void setBackupSets(ReplicaSetInfo[] BackupSets)

Set Specify the node name of a replica set instance or the shard name list of a sharded cluster instance. Only backups of the specified node or shards will be downloaded. Suppose you have a replica set instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0` to download the full backup. For a replica set instance, the parameter value must be in the format of "instance ID_0". Suppose you have a sharded cluster instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1` to download the backup data of shard 0 and shard 1. To download the full backup, please specify all shard names.

Parameters:

BackupSets - Specify the node name of a replica set instance or the shard name list of a sharded cluster instance. Only backups of the specified node or shards will be downloaded. Suppose you have a replica set instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0` to download the full backup. For a replica set instance, the parameter value must be in the format of "instance ID_0". Suppose you have a sharded cluster instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1` to download the backup data of shard 0 and shard 1. To download the full backup, please specify all shard names.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel