Reference documentation and code samples for the Google Cloud Dms V1 Client class ConnectionProfile.
A connection profile definition.
Generated from protobuf message google.cloud.clouddms.v1.ConnectionProfile
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". |
↳ labels |
array|Google\Protobuf\Internal\MapField
The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: |
↳ state |
int
The current connection profile state (e.g. DRAFT, READY, or FAILED). |
↳ display_name |
string
The connection profile display name. |
↳ mysql |
Google\Cloud\CloudDms\V1\MySqlConnectionProfile
A MySQL database connection profile. |
↳ postgresql |
Google\Cloud\CloudDms\V1\PostgreSqlConnectionProfile
A PostgreSQL database connection profile. |
↳ oracle |
Google\Cloud\CloudDms\V1\OracleConnectionProfile
An Oracle database connection profile. |
↳ cloudsql |
Google\Cloud\CloudDms\V1\CloudSqlConnectionProfile
A CloudSQL database connection profile. |
↳ alloydb |
Google\Cloud\CloudDms\V1\AlloyDbConnectionProfile
An AlloyDB cluster connection profile. |
↳ error |
Google\Rpc\Status
Output only. The error details in case of state FAILED. |
↳ provider |
int
The database provider. |
getName
The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The timestamp when the resource was created.
A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when the resource was created.
A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The timestamp when the resource was last updated.
A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when the resource was last updated.
A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.
Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.
Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
The current connection profile state (e.g. DRAFT, READY, or FAILED).
| Returns | |
|---|---|
| Type | Description |
int | |
setState
The current connection profile state (e.g. DRAFT, READY, or FAILED).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
The connection profile display name.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
The connection profile display name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMysql
A MySQL database connection profile.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\CloudDms\V1\MySqlConnectionProfile|null | |
hasMysql
setMysql
A MySQL database connection profile.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\CloudDms\V1\MySqlConnectionProfile
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPostgresql
A PostgreSQL database connection profile.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\CloudDms\V1\PostgreSqlConnectionProfile|null | |
hasPostgresql
setPostgresql
A PostgreSQL database connection profile.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\CloudDms\V1\PostgreSqlConnectionProfile
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOracle
An Oracle database connection profile.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\CloudDms\V1\OracleConnectionProfile|null | |
hasOracle
setOracle
An Oracle database connection profile.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\CloudDms\V1\OracleConnectionProfile
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCloudsql
A CloudSQL database connection profile.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\CloudDms\V1\CloudSqlConnectionProfile|null | |
hasCloudsql
setCloudsql
A CloudSQL database connection profile.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\CloudDms\V1\CloudSqlConnectionProfile
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAlloydb
An AlloyDB cluster connection profile.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\CloudDms\V1\AlloyDbConnectionProfile|null | |
hasAlloydb
setAlloydb
An AlloyDB cluster connection profile.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\CloudDms\V1\AlloyDbConnectionProfile
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getError
Output only. The error details in case of state FAILED.
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
hasError
clearError
setError
Output only. The error details in case of state FAILED.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProvider
The database provider.
| Returns | |
|---|---|
| Type | Description |
int | |
setProvider
The database provider.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConnectionProfile
| Returns | |
|---|---|
| Type | Description |
string | |