Google Cloud Dms V1 Client - Class CloudSqlConnectionProfile (1.1.0)

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

Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ cloud_sql_id string

Output only. The Cloud SQL instance ID that this connection profile is associated with.

↳ settings Google\Cloud\CloudDms\V1\CloudSqlSettings

Immutable. Metadata used to create the destination Cloud SQL database.

↳ private_ip string

Output only. The Cloud SQL database instance's private IP.

↳ public_ip string

Output only. The Cloud SQL database instance's public IP.

↳ additional_public_ip string

Output only. The Cloud SQL database instance's additional (outgoing) public IP. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).

getCloudSqlId

Output only. The Cloud SQL instance ID that this connection profile is associated with.

Returns
TypeDescription
string

setCloudSqlId

Output only. The Cloud SQL instance ID that this connection profile is associated with.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSettings

Immutable. Metadata used to create the destination Cloud SQL database.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\CloudSqlSettings|null

hasSettings

clearSettings

setSettings

Immutable. Metadata used to create the destination Cloud SQL database.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\CloudSqlSettings
Returns
TypeDescription
$this

getPrivateIp

Output only. The Cloud SQL database instance's private IP.

Returns
TypeDescription
string

setPrivateIp

Output only. The Cloud SQL database instance's private IP.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPublicIp

Output only. The Cloud SQL database instance's public IP.

Returns
TypeDescription
string

setPublicIp

Output only. The Cloud SQL database instance's public IP.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAdditionalPublicIp

Output only. The Cloud SQL database instance's additional (outgoing) public IP. Used when the Cloud SQL database availability type is REGIONAL (i.e.

multiple zones / highly available).

Returns
TypeDescription
string

setAdditionalPublicIp

Output only. The Cloud SQL database instance's additional (outgoing) public IP. Used when the Cloud SQL database availability type is REGIONAL (i.e.

multiple zones / highly available).

Parameter
NameDescription
var string
Returns
TypeDescription
$this