Google Cloud Dms V1 Client - Class ApplyConversionWorkspaceRequest (1.4.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
NameDescription
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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getFilter

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

Returns
TypeDescription
string

setFilter

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDryRun

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

Returns
TypeDescription
bool

setDryRun

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getAutoCommit

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

Returns
TypeDescription
bool

setAutoCommit

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getConnectionProfile

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

Returns
TypeDescription
string

hasConnectionProfile

setConnectionProfile

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDestination

Returns
TypeDescription
string