UpdateInstanceRequest (dms_enterprise20181101 1.68.1 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.dms_enterprise20181101.models.UpdateInstanceRequest

public class UpdateInstanceRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`databasePassword` The password that is used to log on to the database.
`String`	`databaseUser` The account that is used to log on to the database.
`String`	`dataLinkName` The name of the database link for cross-database queries.
`String`	`dbaId` The ID of the user who assumes the database administrator (DBA) role of the database instance.
`Integer`	`ddlOnline` Specifies whether to enable the lock-free schema change feature for the database instance.
`String`	`ecsInstanceId` The ID of the ECS instance on which the database instance is deployed.
`String`	`ecsRegion` The ID of the region in which the database instance resides.
`String`	`enableSellSitd` Y: enables the sensitive data protection feature N: disables the sensitive data protection feature NULL or other: does not update the status of the sensitive data protection feature example: Y
`String`	`envType` The type of the environment in which the database instance is deployed.
`Integer`	`exportTimeout` The timeout period for exporting data from the database instance.
`String`	`host` The host address that is used to connect to the database instance.
`String`	`instanceAlias` The alias of the database instance.
`String`	`instanceId` The ID of the database instance.
`String`	`instanceSource` The source of the database instance.
`String`	`instanceType` The type of the database.
`Integer`	`port` The port that is used to connect to the database instance.
`Integer`	`queryTimeout` The timeout period for querying data in the database instance.
`String`	`safeRuleId` The name of the security rule set (GroupName) for the instance.
`String`	`sid` The system ID (SID) of the database instance.
`Boolean`	`skipTest` Specifies whether to skip the connectivity test.
`Long`	`templateId` The ID of the classification template.
`String`	`templateType` The type of the classification template.
`Long`	`tid` The ID of the tenant.
`Integer`	`useDsql` Specifies whether to enable the cross-database query feature for the database instance.
`String`	`vpcId` The ID of the VPC to which the database instance belongs.

构造器概要

构造器
构造器和说明

UpdateInstanceRequest()

构造器
构造器和说明
`UpdateInstanceRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static UpdateInstanceRequest`	`build(Map<String,?> map)`
`String`	`getDatabasePassword()`
`String`	`getDatabaseUser()`
`String`	`getDataLinkName()`
`String`	`getDbaId()`
`Integer`	`getDdlOnline()`
`String`	`getEcsInstanceId()`
`String`	`getEcsRegion()`
`String`	`getEnableSellSitd()`
`String`	`getEnvType()`
`Integer`	`getExportTimeout()`
`String`	`getHost()`
`String`	`getInstanceAlias()`
`String`	`getInstanceId()`
`String`	`getInstanceSource()`
`String`	`getInstanceType()`
`Integer`	`getPort()`
`Integer`	`getQueryTimeout()`
`String`	`getSafeRuleId()`
`String`	`getSid()`
`Boolean`	`getSkipTest()`
`Long`	`getTemplateId()`
`String`	`getTemplateType()`
`Long`	`getTid()`
`Integer`	`getUseDsql()`
`String`	`getVpcId()`
`UpdateInstanceRequest`	`setDatabasePassword(String databasePassword)`
`UpdateInstanceRequest`	`setDatabaseUser(String databaseUser)`
`UpdateInstanceRequest`	`setDataLinkName(String dataLinkName)`
`UpdateInstanceRequest`	`setDbaId(String dbaId)`
`UpdateInstanceRequest`	`setDdlOnline(Integer ddlOnline)`
`UpdateInstanceRequest`	`setEcsInstanceId(String ecsInstanceId)`
`UpdateInstanceRequest`	`setEcsRegion(String ecsRegion)`
`UpdateInstanceRequest`	`setEnableSellSitd(String enableSellSitd)`
`UpdateInstanceRequest`	`setEnvType(String envType)`
`UpdateInstanceRequest`	`setExportTimeout(Integer exportTimeout)`
`UpdateInstanceRequest`	`setHost(String host)`
`UpdateInstanceRequest`	`setInstanceAlias(String instanceAlias)`
`UpdateInstanceRequest`	`setInstanceId(String instanceId)`
`UpdateInstanceRequest`	`setInstanceSource(String instanceSource)`
`UpdateInstanceRequest`	`setInstanceType(String instanceType)`
`UpdateInstanceRequest`	`setPort(Integer port)`
`UpdateInstanceRequest`	`setQueryTimeout(Integer queryTimeout)`
`UpdateInstanceRequest`	`setSafeRuleId(String safeRuleId)`
`UpdateInstanceRequest`	`setSid(String sid)`
`UpdateInstanceRequest`	`setSkipTest(Boolean skipTest)`
`UpdateInstanceRequest`	`setTemplateId(Long templateId)`
`UpdateInstanceRequest`	`setTemplateType(String templateType)`
`UpdateInstanceRequest`	`setTid(Long tid)`
`UpdateInstanceRequest`	`setUseDsql(Integer useDsql)`
`UpdateInstanceRequest`	`setVpcId(String vpcId)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - dataLinkName
```
@NameInMap(value="DataLinkName")
public String dataLinkName
```
    The name of the database link for cross-database queries.
    - This parameter is required if UseDsql is set to 1.
    - The name can contain only lowercase letters and underscores (_).
    - The name must be unique within a tenant.
    example:
    datalink_test
  - databasePassword
```
@NameInMap(value="DatabasePassword")
public String databasePassword
```
    The password that is used to log on to the database.
    
    This parameter is required.
    example:
  - databaseUser
```
@NameInMap(value="DatabaseUser")
public String databaseUser
```
    The account that is used to log on to the database.
    
    This parameter is required.
    example:
    dbuser
  - dbaId
```
@NameInMap(value="DbaId")
public String dbaId
```
    The ID of the user who assumes the database administrator (DBA) role of the database instance. You can call the ListUsers or GetInstance operation to query the user ID.
    
    This parameter is required.
    example:
    27****
  - ddlOnline
```
@NameInMap(value="DdlOnline")
public Integer ddlOnline
```
    Specifies whether to enable the lock-free schema change feature for the database instance. Valid values:
    - 0: disables the lock-free schema change feature.
    - 1: uses the online DDL of MySQL first.
    - 2: uses the lock-free schema change feature of DMS first.
    example:
    0
  - ecsInstanceId
```
@NameInMap(value="EcsInstanceId")
public String ecsInstanceId
```
    The ID of the ECS instance on which the database instance is deployed.
    
    This parameter is required if the InstanceSource parameter is set to ECS_OWN.
    
    example:
    i-2zei9gs1t7h8l7ac****
  - ecsRegion
```
@NameInMap(value="EcsRegion")
public String ecsRegion
```
    The ID of the region in which the database instance resides.
    
    This parameter is required if InstanceSource is set to RDS, ECS_OWN, and VPC_IDC.
    
    example:
    cn-hangzhou
  - enableSellSitd
```
@NameInMap(value="EnableSellSitd")
public String enableSellSitd
```
    - Y: enables the sensitive data protection feature
    - N: disables the sensitive data protection feature
    - NULL or other: does not update the status of the sensitive data protection feature
    example:
    Y
  - envType
```
@NameInMap(value="EnvType")
public String envType
```
    The type of the environment in which the database instance is deployed. Valid values:
    - product: production environment
    - dev: development environment
    - pre: pre-release environment
    - test: test environment
    - sit: system integration testing (SIT) environment
    - uat: user acceptance testing (UAT) environment
    - pet: stress testing environment
    - stag: staging environment
    This parameter is required.
    example:
    product
  - exportTimeout
```
@NameInMap(value="ExportTimeout")
public Integer exportTimeout
```
    The timeout period for exporting data from the database instance.
    
    This parameter is required.
    example:
    600
  - host
```
@NameInMap(value="Host")
public String host
```
    The host address that is used to connect to the database instance.
    
    This parameter is required.
    example:
    192.XXX.0.56
  - instanceAlias
```
@NameInMap(value="InstanceAlias")
public String instanceAlias
```
    The alias of the database instance. Specify an alias that can help you identify the database instance in DMS.
    
    This parameter is required.
    example:
    instance_test
  - instanceId
```
@NameInMap(value="InstanceId")
public String instanceId
```
    The ID of the database instance. You can call the GetInstance operation to query the instance ID.
    
    This parameter is required.
    example:
    126****
  - instanceSource
```
@NameInMap(value="InstanceSource")
public String instanceSource
```
    The source of the database instance. Valid values:
    - PUBLIC_OWN: a self-managed database instance that is deployed on the Internet
    - RDS: an ApsaraDB RDS instance
    - ECS_OWN: a self-managed database that is deployed on an Elastic Compute Service (ECS) instance
    - VPC_IDC: a self-managed database instance that is deployed in a data center connected over a virtual private cloud (VPC)
    This parameter is required.
    example:
    ECS_OWN
  - instanceType
```
@NameInMap(value="InstanceType")
public String instanceType
```
    The type of the database. For more information about the valid values of this parameter, see DbType parameter.
    
    This parameter is required.
    example:
    mysql
  - port
```
@NameInMap(value="Port")
public Integer port
```
    The port that is used to connect to the database instance.
    
    This parameter is required.
    example:
    3306
  - queryTimeout
```
@NameInMap(value="QueryTimeout")
public Integer queryTimeout
```
    The timeout period for querying data in the database instance.
    
    This parameter is required.
    example:
    60
  - safeRuleId
```
@NameInMap(value="SafeRuleId")
public String safeRuleId
```
    The name of the security rule set (GroupName) for the instance. You can call the ListStandardGroups or GetInstance operation to query the name of the security rule set.
    
    This parameter is required.
    example:
    3****
  - sid
```
@NameInMap(value="Sid")
public String sid
```
    The system ID (SID) of the database instance.
    
    This parameter is required if the InstanceType parameter is set to ORACLE.
    
    example:
    XXX
  - skipTest
```
@NameInMap(value="SkipTest")
public Boolean skipTest
```
    Specifies whether to skip the connectivity test. Valid values:
    - true: skips the connectivity test
    - false: does not skip the connectivity test
    example:
    false
  - templateId
```
@NameInMap(value="TemplateId")
public Long templateId
```
    The ID of the classification template. You can call the ListClassificationTemplates operation to query the template ID.
    example:
    3***
  - templateType
```
@NameInMap(value="TemplateType")
public String templateType
```
    The type of the classification template. You can call the ListClassificationTemplates operation to query the template type.
    example:
    INNER
  - tid
```
@NameInMap(value="Tid")
public Long tid
```
    The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.
    example:
    3***
  - useDsql
```
@NameInMap(value="UseDsql")
public Integer useDsql
```
    Specifies whether to enable the cross-database query feature for the database instance. Valid values:
    - 0: disables the cross-database query feature.
    - 1: enables the cross-database query feature.
    Supported database types: MySQL, SQL Server, PostgreSQL, PolarDB for PostgreSQL (compatible with Oracle), and ApsaraDB for Redis.
    
    example:
    0
  - vpcId
```
@NameInMap(value="VpcId")
public String vpcId
```
    The ID of the VPC to which the database instance belongs.
    
    This parameter is required if the InstanceSource parameter is set to VPC_IDC.
    
    example:
    vpc-xxx
- 构造器详细资料
  - UpdateInstanceRequest
```
public UpdateInstanceRequest()
```
- 方法详细资料
  - build
```
public static UpdateInstanceRequest build(Map<String,?> map)
                                   throws Exception
```
    抛出:
    
    Exception
  - setDataLinkName
```
public UpdateInstanceRequest setDataLinkName(String dataLinkName)
```
  - getDataLinkName
```
public String getDataLinkName()
```
  - setDatabasePassword
```
public UpdateInstanceRequest setDatabasePassword(String databasePassword)
```
  - getDatabasePassword
```
public String getDatabasePassword()
```
  - setDatabaseUser
```
public UpdateInstanceRequest setDatabaseUser(String databaseUser)
```
  - getDatabaseUser
```
public String getDatabaseUser()
```
  - setDbaId
```
public UpdateInstanceRequest setDbaId(String dbaId)
```
  - getDbaId
```
public String getDbaId()
```
  - setDdlOnline
```
public UpdateInstanceRequest setDdlOnline(Integer ddlOnline)
```
  - getDdlOnline
```
public Integer getDdlOnline()
```
  - setEcsInstanceId
```
public UpdateInstanceRequest setEcsInstanceId(String ecsInstanceId)
```
  - getEcsInstanceId
```
public String getEcsInstanceId()
```
  - setEcsRegion
```
public UpdateInstanceRequest setEcsRegion(String ecsRegion)
```
  - getEcsRegion
```
public String getEcsRegion()
```
  - setEnableSellSitd
```
public UpdateInstanceRequest setEnableSellSitd(String enableSellSitd)
```
  - getEnableSellSitd
```
public String getEnableSellSitd()
```
  - setEnvType
```
public UpdateInstanceRequest setEnvType(String envType)
```
  - getEnvType
```
public String getEnvType()
```
  - setExportTimeout
```
public UpdateInstanceRequest setExportTimeout(Integer exportTimeout)
```
  - getExportTimeout
```
public Integer getExportTimeout()
```
  - setHost
```
public UpdateInstanceRequest setHost(String host)
```
  - getHost
```
public String getHost()
```
  - setInstanceAlias
```
public UpdateInstanceRequest setInstanceAlias(String instanceAlias)
```
  - getInstanceAlias
```
public String getInstanceAlias()
```
  - setInstanceId
```
public UpdateInstanceRequest setInstanceId(String instanceId)
```
  - getInstanceId
```
public String getInstanceId()
```
  - setInstanceSource
```
public UpdateInstanceRequest setInstanceSource(String instanceSource)
```
  - getInstanceSource
```
public String getInstanceSource()
```
  - setInstanceType
```
public UpdateInstanceRequest setInstanceType(String instanceType)
```
  - getInstanceType
```
public String getInstanceType()
```
  - setPort
```
public UpdateInstanceRequest setPort(Integer port)
```
  - getPort
```
public Integer getPort()
```
  - setQueryTimeout
```
public UpdateInstanceRequest setQueryTimeout(Integer queryTimeout)
```
  - getQueryTimeout
```
public Integer getQueryTimeout()
```
  - setSafeRuleId
```
public UpdateInstanceRequest setSafeRuleId(String safeRuleId)
```
  - getSafeRuleId
```
public String getSafeRuleId()
```
  - setSid
```
public UpdateInstanceRequest setSid(String sid)
```
  - getSid
```
public String getSid()
```
  - setSkipTest
```
public UpdateInstanceRequest setSkipTest(Boolean skipTest)
```
  - getSkipTest
```
public Boolean getSkipTest()
```
  - setTemplateId
```
public UpdateInstanceRequest setTemplateId(Long templateId)
```
  - getTemplateId
```
public Long getTemplateId()
```
  - setTemplateType
```
public UpdateInstanceRequest setTemplateType(String templateType)
```
  - getTemplateType
```
public String getTemplateType()
```
  - setTid
```
public UpdateInstanceRequest setTid(Long tid)
```
  - getTid
```
public Long getTid()
```
  - setUseDsql
```
public UpdateInstanceRequest setUseDsql(Integer useDsql)
```
  - getUseDsql
```
public Integer getUseDsql()
```
  - setVpcId
```
public UpdateInstanceRequest setVpcId(String vpcId)
```
  - getVpcId
```
public String getVpcId()
```

类 UpdateInstanceRequest

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

dataLinkName

databasePassword

databaseUser

dbaId

ddlOnline

ecsInstanceId

ecsRegion

enableSellSitd

envType

exportTimeout

host

instanceAlias

instanceId

instanceSource

instanceType

port

queryTimeout

safeRuleId

sid

skipTest

templateId

templateType

tid

useDsql

vpcId

构造器详细资料

UpdateInstanceRequest

方法详细资料

build

setDataLinkName

getDataLinkName

setDatabasePassword

getDatabasePassword

setDatabaseUser

getDatabaseUser

setDbaId

getDbaId

setDdlOnline

getDdlOnline

setEcsInstanceId

getEcsInstanceId

setEcsRegion

getEcsRegion

setEnableSellSitd

getEnableSellSitd

setEnvType

getEnvType

setExportTimeout

getExportTimeout

setHost

getHost

setInstanceAlias

getInstanceAlias

setInstanceId

getInstanceId

setInstanceSource

getInstanceSource

setInstanceType

getInstanceType

setPort

getPort

setQueryTimeout

getQueryTimeout

setSafeRuleId

getSafeRuleId

setSid

getSid

setSkipTest

getSkipTest

setTemplateId

getTemplateId

setTemplateType

getTemplateType