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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["\u003cp\u003eThis API endpoint applies a draft tree to a specified destination database using a POST request to \u003ccode\u003ehttps://datamigration.googleapis.com/v1/{name}:apply\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e path parameter is required and represents the conversion workspace resource, formatted as \u003ccode\u003eprojects/{project}/locations/{location}/conversionWorkspaces/{conversionWorkspace}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body can include filters, dry run options, and auto-commit settings, as well as the connection profile of the destination database.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edryRun\u003c/code\u003e option is available for validation without modifying the database, and it is specific to PostgreSQL destination connection profiles.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests return an \u003ccode\u003eOperation\u003c/code\u003e instance, and authorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.conversionWorkspaces.apply\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nApplies draft tree onto a specific destination database.\n\n### HTTP request\n\n`POST https://datamigration.googleapis.com/v1/{name}:apply`\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/database-migration/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]
