Google Cloud Dms V1 Client - Class ApplyConversionWorkspaceRequest (2.0.2)

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

Request message for 'ApplyConversionWorkspace' request.

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

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the conversion workspace resource for which to apply the draft tree. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

↳ filter string

Filter which entities to apply. Leaving this field empty will apply all of the entities. Supports Google AIP 160 based filtering.

↳ dry_run bool

Optional. Only validates the apply process, but doesn't change the destination database. Only works for PostgreSQL destination connection profile.

↳ auto_commit bool

Optional. Specifies whether the conversion workspace is to be committed automatically after the apply.

↳ connection_profile string

Optional. Fully qualified (Uri) name of the destination connection profile.

getName

Required. The name of the conversion workspace resource for which to apply the draft tree. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

Returns
Type Description
string

setName

Required. The name of the conversion workspace resource for which to apply the draft tree. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Filter which entities to apply. Leaving this field empty will apply all of the entities. Supports Google AIP 160 based filtering.

Returns
Type Description
string

setFilter

Filter which entities to apply. Leaving this field empty will apply all of the entities. Supports Google AIP 160 based filtering.

Parameter
Name Description
var string
Returns
Type Description
$this

getDryRun

Optional. Only validates the apply process, but doesn't change the destination database. Only works for PostgreSQL destination connection profile.

Returns
Type Description
bool

setDryRun

Optional. Only validates the apply process, but doesn't change the destination database. Only works for PostgreSQL destination connection profile.

Parameter
Name Description
var bool
Returns
Type Description
$this

getAutoCommit

Optional. Specifies whether the conversion workspace is to be committed automatically after the apply.

Returns
Type Description
bool

setAutoCommit

Optional. Specifies whether the conversion workspace is to be committed automatically after the apply.

Parameter
Name Description
var bool
Returns
Type Description
$this

getConnectionProfile

Optional. Fully qualified (Uri) name of the destination connection profile.

Returns
Type Description
string

hasConnectionProfile

setConnectionProfile

Optional. Fully qualified (Uri) name of the destination connection profile.

Parameter
Name Description
var string
Returns
Type Description
$this

getDestination

Returns
Type Description
string