InstanceDetail (tencentcloud-sdk-java-intl-en 3.0.61 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.mongodb.v20190725.models.InstanceDetail

public class InstanceDetail
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description

InstanceDetail()

Constructors
Constructor and Description
`InstanceDetail()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getAutoRenewFlag()` Get Instance auto-renewal flag.
`DBInstanceInfo[]`	`getCloneInstances()` Get Information of temp instances
`Long`	`getClusterType()` Get Cluster type.
`Long`	`getClusterVer()` Get Instance version tag
`Long`	`getCpuNum()` Get Number of CPU cores of an instance
`String`	`getCreateTime()` Get Instance creation time
`String`	`getDeadLine()` Get Instance expiration time
`String`	`getInstanceId()` Get Instance ID
`String`	`getInstanceName()` Get Instance name
`String`	`getInstanceStatusDesc()` Get Instance status description
`Long`	`getInstanceType()` Get Instance type.
`Long`	`getInstanceVer()` Get Instance version tag
`String`	`getMachineType()` Get Instance machine type
`String`	`getMaintenanceEnd()` Get End time of the maintenance time window
`String`	`getMaintenanceStart()` Get Start time of the maintenance time window
`Long`	`getMemory()` Get Instance memory size in MB
`String`	`getMongoVersion()` Get Instance version information
`Long`	`getNetType()` Get Network type.
`Long`	`getPayMode()` Get Billing type.
`Long`	`getProjectId()` Get Project ID
`Long`	`getProtocol()` Get Protocol information.
`DBInstanceInfo[]`	`getReadonlyInstances()` Get Information of read-only instances
`String`	`getRealInstanceId()` Get Physical instance ID.
`String`	`getRegion()` Get Region information
`DBInstanceInfo`	`getRelatedInstance()` Get Information of associated instances.
`ShardInfo[]`	`getReplicaSets()` Get Shard information
`Long`	`getReplicationSetNum()` Get Number of instance shards
`Long`	`getSecondaryNum()` Get Number of secondary nodes of an instance
`DBInstanceInfo[]`	`getStandbyInstances()` Get Information of disaster recovery instances
`Long`	`getStatus()` Get Instance status.
`String`	`getSubnetId()` Get Subnet ID of VPC
`TagInfo[]`	`getTags()` Get Instance tag information set
`Long`	`getUsedVolume()` Get Used capacity in MB
`String`	`getVip()` Get Instance IP
`Long`	`getVolume()` Get Instance disk size in MB
`String`	`getVpcId()` Get VPC ID
`Long`	`getVport()` Get Port number
`String`	`getZone()` Get AZ information
`void`	`setAutoRenewFlag(Long AutoRenewFlag)` Set Instance auto-renewal flag.
`void`	`setCloneInstances(DBInstanceInfo[] CloneInstances)` Set Information of temp instances
`void`	`setClusterType(Long ClusterType)` Set Cluster type.
`void`	`setClusterVer(Long ClusterVer)` Set Instance version tag
`void`	`setCpuNum(Long CpuNum)` Set Number of CPU cores of an instance
`void`	`setCreateTime(String CreateTime)` Set Instance creation time
`void`	`setDeadLine(String DeadLine)` Set Instance expiration time
`void`	`setInstanceId(String InstanceId)` Set Instance ID
`void`	`setInstanceName(String InstanceName)` Set Instance name
`void`	`setInstanceStatusDesc(String InstanceStatusDesc)` Set Instance status description
`void`	`setInstanceType(Long InstanceType)` Set Instance type.
`void`	`setInstanceVer(Long InstanceVer)` Set Instance version tag
`void`	`setMachineType(String MachineType)` Set Instance machine type
`void`	`setMaintenanceEnd(String MaintenanceEnd)` Set End time of the maintenance time window
`void`	`setMaintenanceStart(String MaintenanceStart)` Set Start time of the maintenance time window
`void`	`setMemory(Long Memory)` Set Instance memory size in MB
`void`	`setMongoVersion(String MongoVersion)` Set Instance version information
`void`	`setNetType(Long NetType)` Set Network type.
`void`	`setPayMode(Long PayMode)` Set Billing type.
`void`	`setProjectId(Long ProjectId)` Set Project ID
`void`	`setProtocol(Long Protocol)` Set Protocol information.
`void`	`setReadonlyInstances(DBInstanceInfo[] ReadonlyInstances)` Set Information of read-only instances
`void`	`setRealInstanceId(String RealInstanceId)` Set Physical instance ID.
`void`	`setRegion(String Region)` Set Region information
`void`	`setRelatedInstance(DBInstanceInfo RelatedInstance)` Set Information of associated instances.
`void`	`setReplicaSets(ShardInfo[] ReplicaSets)` Set Shard information
`void`	`setReplicationSetNum(Long ReplicationSetNum)` Set Number of instance shards
`void`	`setSecondaryNum(Long SecondaryNum)` Set Number of secondary nodes of an instance
`void`	`setStandbyInstances(DBInstanceInfo[] StandbyInstances)` Set Information of disaster recovery instances
`void`	`setStatus(Long Status)` Set Instance status.
`void`	`setSubnetId(String SubnetId)` Set Subnet ID of VPC
`void`	`setTags(TagInfo[] Tags)` Set Instance tag information set
`void`	`setUsedVolume(Long UsedVolume)` Set Used capacity in MB
`void`	`setVip(String Vip)` Set Instance IP
`void`	`setVolume(Long Volume)` Set Instance disk size in MB
`void`	`setVpcId(String VpcId)` Set VPC ID
`void`	`setVport(Long Vport)` Set Port number
`void`	`setZone(String Zone)` Set AZ information
`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
  - InstanceDetail
```
public InstanceDetail()
```
- Method Detail
  - getInstanceId
```
public String getInstanceId()
```
    Get Instance ID
    
    Returns:
    
    InstanceId Instance ID
  - setInstanceId
```
public void setInstanceId(String InstanceId)
```
    Set Instance ID
    
    Parameters:
    
    InstanceId - Instance ID
  - getInstanceName
```
public String getInstanceName()
```
    Get Instance name
    
    Returns:
    
    InstanceName Instance name
  - setInstanceName
```
public void setInstanceName(String InstanceName)
```
    Set Instance name
    
    Parameters:
    
    InstanceName - Instance name
  - getPayMode
```
public Long getPayMode()
```
    Get Billing type. Valid value: 0 (pay-as-you-go)
    
    Returns:
    
    PayMode Billing type. Valid value: 0 (pay-as-you-go)
  - setPayMode
```
public void setPayMode(Long PayMode)
```
    Set Billing type. Valid value: 0 (pay-as-you-go)
    
    Parameters:
    
    PayMode - Billing type. Valid value: 0 (pay-as-you-go)
  - getProjectId
```
public Long getProjectId()
```
    Get Project ID
    
    Returns:
    
    ProjectId Project ID
  - setProjectId
```
public void setProjectId(Long ProjectId)
```
    Set Project ID
    
    Parameters:
    
    ProjectId - Project ID
  - getClusterType
```
public Long getClusterType()
```
    Get Cluster type. Valid values: 0 (replica set instance), 1 (sharding instance),
    
    Returns:
    
    ClusterType Cluster type. Valid values: 0 (replica set instance), 1 (sharding instance),
  - setClusterType
```
public void setClusterType(Long ClusterType)
```
    Set Cluster type. Valid values: 0 (replica set instance), 1 (sharding instance),
    
    Parameters:
    
    ClusterType - Cluster type. Valid values: 0 (replica set instance), 1 (sharding instance),
  - getRegion
```
public String getRegion()
```
    Get Region information
    
    Returns:
    
    Region Region information
  - setRegion
```
public void setRegion(String Region)
```
    Set Region information
    
    Parameters:
    
    Region - Region information
  - getZone
```
public String getZone()
```
    Get AZ information
    
    Returns:
    
    Zone AZ information
  - setZone
```
public void setZone(String Zone)
```
    Set AZ information
    
    Parameters:
    
    Zone - AZ information
  - getNetType
```
public Long getNetType()
```
    Get Network type. Valid values: 0 (basic network), 1 (VPC)
    
    Returns:
    
    NetType Network type. Valid values: 0 (basic network), 1 (VPC)
  - setNetType
```
public void setNetType(Long NetType)
```
    Set Network type. Valid values: 0 (basic network), 1 (VPC)
    
    Parameters:
    
    NetType - Network type. Valid values: 0 (basic network), 1 (VPC)
  - getVpcId
```
public String getVpcId()
```
    Get VPC ID
    
    Returns:
    
    VpcId VPC ID
  - setVpcId
```
public void setVpcId(String VpcId)
```
    Set VPC ID
    
    Parameters:
    
    VpcId - VPC ID
  - getSubnetId
```
public String getSubnetId()
```
    Get Subnet ID of VPC
    
    Returns:
    
    SubnetId Subnet ID of VPC
  - setSubnetId
```
public void setSubnetId(String SubnetId)
```
    Set Subnet ID of VPC
    
    Parameters:
    
    SubnetId - Subnet ID of VPC
  - getStatus
```
public Long getStatus()
```
    Get Instance status. Valid values: 0 (to be initialized), 1 (in process), 2 (running), -2 (expired)
    
    Returns:
    
    Status Instance status. Valid values: 0 (to be initialized), 1 (in process), 2 (running), -2 (expired)
  - setStatus
```
public void setStatus(Long Status)
```
    Set Instance status. Valid values: 0 (to be initialized), 1 (in process), 2 (running), -2 (expired)
    
    Parameters:
    
    Status - Instance status. Valid values: 0 (to be initialized), 1 (in process), 2 (running), -2 (expired)
  - getVip
```
public String getVip()
```
    Get Instance IP
    
    Returns:
    
    Vip Instance IP
  - setVip
```
public void setVip(String Vip)
```
    Set Instance IP
    
    Parameters:
    
    Vip - Instance IP
  - getVport
```
public Long getVport()
```
    Get Port number
    
    Returns:
    
    Vport Port number
  - setVport
```
public void setVport(Long Vport)
```
    Set Port number
    
    Parameters:
    
    Vport - Port number
  - getCreateTime
```
public String getCreateTime()
```
    Get Instance creation time
    
    Returns:
    
    CreateTime Instance creation time
  - setCreateTime
```
public void setCreateTime(String CreateTime)
```
    Set Instance creation time
    
    Parameters:
    
    CreateTime - Instance creation time
  - getDeadLine
```
public String getDeadLine()
```
    Get Instance expiration time
    
    Returns:
    
    DeadLine Instance expiration time
  - setDeadLine
```
public void setDeadLine(String DeadLine)
```
    Set Instance expiration time
    
    Parameters:
    
    DeadLine - Instance expiration time
  - getMongoVersion
```
public String getMongoVersion()
```
    Get Instance version information
    
    Returns:
    
    MongoVersion Instance version information
  - setMongoVersion
```
public void setMongoVersion(String MongoVersion)
```
    Set Instance version information
    
    Parameters:
    
    MongoVersion - Instance version information
  - getMemory
```
public Long getMemory()
```
    Get Instance memory size in MB
    
    Returns:
    
    Memory Instance memory size in MB
  - setMemory
```
public void setMemory(Long Memory)
```
    Set Instance memory size in MB
    
    Parameters:
    
    Memory - Instance memory size in MB
  - getVolume
```
public Long getVolume()
```
    Get Instance disk size in MB
    
    Returns:
    
    Volume Instance disk size in MB
  - setVolume
```
public void setVolume(Long Volume)
```
    Set Instance disk size in MB
    
    Parameters:
    
    Volume - Instance disk size in MB
  - getCpuNum
```
public Long getCpuNum()
```
    Get Number of CPU cores of an instance
    
    Returns:
    
    CpuNum Number of CPU cores of an instance
  - setCpuNum
```
public void setCpuNum(Long CpuNum)
```
    Set Number of CPU cores of an instance
    
    Parameters:
    
    CpuNum - Number of CPU cores of an instance
  - getMachineType
```
public String getMachineType()
```
    Get Instance machine type
    
    Returns:
    
    MachineType Instance machine type
  - setMachineType
```
public void setMachineType(String MachineType)
```
    Set Instance machine type
    
    Parameters:
    
    MachineType - Instance machine type
  - getSecondaryNum
```
public Long getSecondaryNum()
```
    Get Number of secondary nodes of an instance
    
    Returns:
    
    SecondaryNum Number of secondary nodes of an instance
  - setSecondaryNum
```
public void setSecondaryNum(Long SecondaryNum)
```
    Set Number of secondary nodes of an instance
    
    Parameters:
    
    SecondaryNum - Number of secondary nodes of an instance
  - getReplicationSetNum
```
public Long getReplicationSetNum()
```
    Get Number of instance shards
    
    Returns:
    
    ReplicationSetNum Number of instance shards
  - setReplicationSetNum
```
public void setReplicationSetNum(Long ReplicationSetNum)
```
    Set Number of instance shards
    
    Parameters:
    
    ReplicationSetNum - Number of instance shards
  - getAutoRenewFlag
```
public Long getAutoRenewFlag()
```
    Get Instance auto-renewal flag. Valid values: 0 (manual renewal), 1 (auto-renewal), 2 (no renewal upon expiration)
    
    Returns:
    
    AutoRenewFlag Instance auto-renewal flag. Valid values: 0 (manual renewal), 1 (auto-renewal), 2 (no renewal upon expiration)
  - setAutoRenewFlag
```
public void setAutoRenewFlag(Long AutoRenewFlag)
```
    Set Instance auto-renewal flag. Valid values: 0 (manual renewal), 1 (auto-renewal), 2 (no renewal upon expiration)
    
    Parameters:
    
    AutoRenewFlag - Instance auto-renewal flag. Valid values: 0 (manual renewal), 1 (auto-renewal), 2 (no renewal upon expiration)
  - getUsedVolume
```
public Long getUsedVolume()
```
    Get Used capacity in MB
    
    Returns:
    
    UsedVolume Used capacity in MB
  - setUsedVolume
```
public void setUsedVolume(Long UsedVolume)
```
    Set Used capacity in MB
    
    Parameters:
    
    UsedVolume - Used capacity in MB
  - getMaintenanceStart
```
public String getMaintenanceStart()
```
    Get Start time of the maintenance time window
    
    Returns:
    
    MaintenanceStart Start time of the maintenance time window
  - setMaintenanceStart
```
public void setMaintenanceStart(String MaintenanceStart)
```
    Set Start time of the maintenance time window
    
    Parameters:
    
    MaintenanceStart - Start time of the maintenance time window
  - getMaintenanceEnd
```
public String getMaintenanceEnd()
```
    Get End time of the maintenance time window
    
    Returns:
    
    MaintenanceEnd End time of the maintenance time window
  - setMaintenanceEnd
```
public void setMaintenanceEnd(String MaintenanceEnd)
```
    Set End time of the maintenance time window
    
    Parameters:
    
    MaintenanceEnd - End time of the maintenance time window
  - getReplicaSets
```
public ShardInfo[] getReplicaSets()
```
    Get Shard information
    
    Returns:
    
    ReplicaSets Shard information
  - setReplicaSets
```
public void setReplicaSets(ShardInfo[] ReplicaSets)
```
    Set Shard information
    
    Parameters:
    
    ReplicaSets - Shard information
  - getReadonlyInstances
```
public DBInstanceInfo[] getReadonlyInstances()
```
    Get Information of read-only instances
    
    Returns:
    
    ReadonlyInstances Information of read-only instances
  - setReadonlyInstances
```
public void setReadonlyInstances(DBInstanceInfo[] ReadonlyInstances)
```
    Set Information of read-only instances
    
    Parameters:
    
    ReadonlyInstances - Information of read-only instances
  - getStandbyInstances
```
public DBInstanceInfo[] getStandbyInstances()
```
    Get Information of disaster recovery instances
    
    Returns:
    
    StandbyInstances Information of disaster recovery instances
  - setStandbyInstances
```
public void setStandbyInstances(DBInstanceInfo[] StandbyInstances)
```
    Set Information of disaster recovery instances
    
    Parameters:
    
    StandbyInstances - Information of disaster recovery instances
  - getCloneInstances
```
public DBInstanceInfo[] getCloneInstances()
```
    Get Information of temp instances
    
    Returns:
    
    CloneInstances Information of temp instances
  - setCloneInstances
```
public void setCloneInstances(DBInstanceInfo[] CloneInstances)
```
    Set Information of temp instances
    
    Parameters:
    
    CloneInstances - Information of temp instances
  - getRelatedInstance
```
public DBInstanceInfo getRelatedInstance()
```
    Get Information of associated instances. For a promoted instance, this field represents information of its temp instance; for a temp instance, this field represents information of its promoted instance; and for a read-only/disaster recovery instance, this field represents information of its primary instance
    
    Returns:
    
    RelatedInstance Information of associated instances. For a promoted instance, this field represents information of its temp instance; for a temp instance, this field represents information of its promoted instance; and for a read-only/disaster recovery instance, this field represents information of its primary instance
  - setRelatedInstance
```
public void setRelatedInstance(DBInstanceInfo RelatedInstance)
```
    Set Information of associated instances. For a promoted instance, this field represents information of its temp instance; for a temp instance, this field represents information of its promoted instance; and for a read-only/disaster recovery instance, this field represents information of its primary instance
    
    Parameters:
    
    RelatedInstance - Information of associated instances. For a promoted instance, this field represents information of its temp instance; for a temp instance, this field represents information of its promoted instance; and for a read-only/disaster recovery instance, this field represents information of its primary instance
  - getTags
```
public TagInfo[] getTags()
```
    Get Instance tag information set
    
    Returns:
    
    Tags Instance tag information set
  - setTags
```
public void setTags(TagInfo[] Tags)
```
    Set Instance tag information set
    
    Parameters:
    
    Tags - Instance tag information set
  - getInstanceVer
```
public Long getInstanceVer()
```
    Get Instance version tag
    
    Returns:
    
    InstanceVer Instance version tag
  - setInstanceVer
```
public void setInstanceVer(Long InstanceVer)
```
    Set Instance version tag
    
    Parameters:
    
    InstanceVer - Instance version tag
  - getClusterVer
```
public Long getClusterVer()
```
    Get Instance version tag
    
    Returns:
    
    ClusterVer Instance version tag
  - setClusterVer
```
public void setClusterVer(Long ClusterVer)
```
    Set Instance version tag
    
    Parameters:
    
    ClusterVer - Instance version tag
  - getProtocol
```
public Long getProtocol()
```
    Get Protocol information. Valid values: 1 (mongodb), 2 (dynamodb)
    
    Returns:
    
    Protocol Protocol information. Valid values: 1 (mongodb), 2 (dynamodb)
  - setProtocol
```
public void setProtocol(Long Protocol)
```
    Set Protocol information. Valid values: 1 (mongodb), 2 (dynamodb)
    
    Parameters:
    
    Protocol - Protocol information. Valid values: 1 (mongodb), 2 (dynamodb)
  - getInstanceType
```
public Long getInstanceType()
```
    Get Instance type. Valid values: 1 (promoted instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance)
    
    Returns:
    
    InstanceType Instance type. Valid values: 1 (promoted instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance)
  - setInstanceType
```
public void setInstanceType(Long InstanceType)
```
    Set Instance type. Valid values: 1 (promoted instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance)
    
    Parameters:
    
    InstanceType - Instance type. Valid values: 1 (promoted instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance)
  - getInstanceStatusDesc
```
public String getInstanceStatusDesc()
```
    Get Instance status description
    
    Returns:
    
    InstanceStatusDesc Instance status description
  - setInstanceStatusDesc
```
public void setInstanceStatusDesc(String InstanceStatusDesc)
```
    Set Instance status description
    
    Parameters:
    
    InstanceStatusDesc - Instance status description
  - getRealInstanceId
```
public String getRealInstanceId()
```
    Get Physical instance ID. For an instance that has been rolled back and replaced, its InstanceId and RealInstanceId are different. The physical instance ID is needed in such scenarios as getting monitoring data from Barad
    
    Returns:
    
    RealInstanceId Physical instance ID. For an instance that has been rolled back and replaced, its InstanceId and RealInstanceId are different. The physical instance ID is needed in such scenarios as getting monitoring data from Barad
  - setRealInstanceId
```
public void setRealInstanceId(String RealInstanceId)
```
    Set Physical instance ID. For an instance that has been rolled back and replaced, its InstanceId and RealInstanceId are different. The physical instance ID is needed in such scenarios as getting monitoring data from Barad
    
    Parameters:
    
    RealInstanceId - Physical instance ID. For an instance that has been rolled back and replaced, its InstanceId and RealInstanceId are different. The physical instance ID is needed in such scenarios as getting monitoring data from Barad
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class InstanceDetail

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

InstanceDetail

Method Detail

getInstanceId

setInstanceId

getInstanceName

setInstanceName

getPayMode

setPayMode

getProjectId

setProjectId

getClusterType

setClusterType

getRegion

setRegion

getZone

setZone

getNetType

setNetType

getVpcId

setVpcId

getSubnetId

setSubnetId

getStatus

setStatus

getVip

setVip

getVport

setVport

getCreateTime

setCreateTime

getDeadLine

setDeadLine

getMongoVersion

setMongoVersion

getMemory

setMemory

getVolume

setVolume

getCpuNum

setCpuNum

getMachineType

setMachineType

getSecondaryNum

setSecondaryNum

getReplicationSetNum

setReplicationSetNum

getAutoRenewFlag

setAutoRenewFlag

getUsedVolume

setUsedVolume

getMaintenanceStart

setMaintenanceStart

getMaintenanceEnd

setMaintenanceEnd

getReplicaSets

setReplicaSets

getReadonlyInstances

setReadonlyInstances

getStandbyInstances

setStandbyInstances

getCloneInstances

setCloneInstances

getRelatedInstance

setRelatedInstance

getTags

setTags

getInstanceVer

setInstanceVer

getClusterVer

setClusterVer

getProtocol

setProtocol

getInstanceType

setInstanceType