Method: projects.locations.conversionWorkspaces.convert

Creates a draft tree schema for the destination database.

HTTP request

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

Path parameters

Parameters
name

string

Name of the conversion workspace resource to convert in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversionWorkspace}.

Request body

The request body contains data with the following structure:

JSON representation
{
  "autoCommit": boolean,
  "filter": string,
  "convertFullPath": boolean
}
Fields
autoCommit

boolean

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

filter

string

Optional. Filter the entities to convert. Leaving this field empty will convert all of the entities. Supports Google AIP-160 style filtering.

convertFullPath

boolean

Optional. Automatically convert the full entity path for each entity specified by the filter. For example, if the filter specifies a table, that table schema (and database if there is one) will also be converted.

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.