Google Cloud Dms V1 Client - Class ConnectionProfile (1.3.0)

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

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

↳ 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
TypeDescription
string

setName

The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getState

The current connection profile state (e.g. DRAFT, READY, or FAILED).

Returns
TypeDescription
int

setState

The current connection profile state (e.g. DRAFT, READY, or FAILED).

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDisplayName

The connection profile display name.

Returns
TypeDescription
string

setDisplayName

The connection profile display name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMysql

A MySQL database connection profile.

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

hasMysql

setMysql

A MySQL database connection profile.

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

getPostgresql

A PostgreSQL database connection profile.

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

hasPostgresql

setPostgresql

A PostgreSQL database connection profile.

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

getOracle

An Oracle database connection profile.

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

hasOracle

setOracle

An Oracle database connection profile.

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

getCloudsql

A CloudSQL database connection profile.

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

hasCloudsql

setCloudsql

A CloudSQL database connection profile.

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

getAlloydb

An AlloyDB cluster connection profile.

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

hasAlloydb

setAlloydb

An AlloyDB cluster connection profile.

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

getError

Output only. The error details in case of state FAILED.

Returns
TypeDescription
Google\Rpc\Status|null

hasError

clearError

setError

Output only. The error details in case of state FAILED.

Parameter
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this

getProvider

The database provider.

Returns
TypeDescription
int

setProvider

The database provider.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getConnectionProfile

Returns
TypeDescription
string