Google Cloud Dms V1 Client - Class MySqlConnectionProfile (2.0.3)

Reference documentation and code samples for the Google Cloud Dms V1 Client class MySqlConnectionProfile.

Specifies connection parameters required specifically for MySQL databases.

Generated from protobuf message google.cloud.clouddms.v1.MySqlConnectionProfile

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ host`	`string` Required. The IP or hostname of the source MySQL database.
`↳ port`	`int` Required. The network port of the source MySQL database.
`↳ username`	`string` Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
`↳ password`	`string` Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
`↳ password_set`	`bool` Output only. Indicates If this connection profile password is stored.
`↳ ssl`	`SslConfig` SSL configuration for the destination to connect to the source database.
`↳ cloud_sql_id`	`string` If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

getHost

Required. The IP or hostname of the source MySQL database.

Returns
Type	Description
`string`

setHost

Required. The IP or hostname of the source MySQL database.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPort

Required. The network port of the source MySQL database.

Returns
Type	Description
`int`

setPort

Required. The network port of the source MySQL database.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getUsername

Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

Returns
Type	Description
`string`

setUsername

Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPassword

Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.

Returns
Type	Description
`string`

setPassword

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPasswordSet

Output only. Indicates If this connection profile password is stored.

Returns
Type	Description
`bool`

setPasswordSet

Output only. Indicates If this connection profile password is stored.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getSsl

SSL configuration for the destination to connect to the source database.

Returns
Type	Description
`SslConfig\|null`

hasSsl

clearSsl

setSsl

SSL configuration for the destination to connect to the source database.

Parameter
Name	Description
`var`	`SslConfig`

Returns
Type	Description
`$this`

getCloudSqlId

If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

Returns
Type	Description
`string`

setCloudSqlId

If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`