Method: projects.locations.conversionWorkspaces.apply

Applies draft tree onto a specific destination database.

HTTP request

POST https://datamigration.googleapis.com/v1/{name}:apply

Path parameters

Parameters
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/{conversionWorkspace}.

Request body

The request body contains data with the following structure:

JSON representation
{
  "filter": string,
  "dryRun": boolean,
  "autoCommit": boolean,

  // Union field destination can be only one of the following:
  "connectionProfile": string
  // End of list of possible types for union field destination.
}
Fields
filter

string

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

dryRun

boolean

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

autoCommit

boolean

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

Union field destination. Which destination to use when applying the conversion workspace. destination can be only one of the following:
connectionProfile

string

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

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.