Google Cloud Dms V1 Client - Class ConversionWorkspace (1.5.5)

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

The main conversion workspace resource entity.

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

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
↳ source Google\Cloud\CloudDms\V1\DatabaseEngineInfo

Required. The source engine details.
↳ destination Google\Cloud\CloudDms\V1\DatabaseEngineInfo

Required. The destination engine details.
↳ global_settings array|Google\Protobuf\Internal\MapField

Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true
↳ has_uncommitted_changes bool

Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed).
↳ latest_commit_id string

Output only. The latest commit ID.
↳ latest_commit_time Google\Protobuf\Timestamp

Output only. The timestamp when the workspace was committed.
↳ create_time Google\Protobuf\Timestamp

Output only. The timestamp when the workspace resource was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The timestamp when the workspace resource was last updated.
↳ display_name string

Optional. The display name for the workspace.

getName

Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

Returns
Type Description
string

setName

Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

Parameter
Name Description
var string
Returns
Type Description
$this

getSource

Required. The source engine details.

Returns
Type Description
Google\Cloud\CloudDms\V1\DatabaseEngineInfo|null

hasSource

clearSource

setSource

Required. The source engine details.

Parameter
Name Description
var Google\Cloud\CloudDms\V1\DatabaseEngineInfo
Returns
Type Description
$this

getDestination

Required. The destination engine details.

Returns
Type Description
Google\Cloud\CloudDms\V1\DatabaseEngineInfo|null

hasDestination

clearDestination

setDestination

Required. The destination engine details.

Parameter
Name Description
var Google\Cloud\CloudDms\V1\DatabaseEngineInfo
Returns
Type Description
$this

getGlobalSettings

Optional. A generic list of settings for the workspace.

The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true

Returns
Type Description
Google\Protobuf\Internal\MapField

setGlobalSettings

Optional. A generic list of settings for the workspace.

The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getHasUncommittedChanges

Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed).

Returns
Type Description
bool

setHasUncommittedChanges

Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed).

Parameter
Name Description
var bool
Returns
Type Description
$this

getLatestCommitId

Output only. The latest commit ID.

Returns
Type Description
string

setLatestCommitId

Output only. The latest commit ID.

Parameter
Name Description
var string
Returns
Type Description
$this

getLatestCommitTime

Output only. The timestamp when the workspace was committed.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLatestCommitTime

clearLatestCommitTime

setLatestCommitTime

Output only. The timestamp when the workspace was committed.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCreateTime

Output only. The timestamp when the workspace resource was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when the workspace resource was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The timestamp when the workspace resource was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp when the workspace resource was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDisplayName

Optional. The display name for the workspace.

Returns
Type Description
string

setDisplayName

Optional. The display name for the workspace.

Parameter
Name Description
var string
Returns
Type Description
$this