class ProjectsLocationsConversionWorkspaces extends Resource (View source)

The "conversionWorkspaces" collection of methods.

Typical usage is:

 $datamigrationService = new Google\Service\DatabaseMigrationService(...);
 $conversionWorkspaces = $datamigrationService->projects_locations_conversionWorkspaces;

Methods

apply(string $name, ApplyConversionWorkspaceRequest $postBody, array $optParams = [])

Applies draft tree onto a specific destination database.

commit(string $name, CommitConversionWorkspaceRequest $postBody, array $optParams = [])

Marks all the data in the conversion workspace as committed.

convert(string $name, ConvertConversionWorkspaceRequest $postBody, array $optParams = [])

Creates a draft tree schema for the destination database.

create(string $parent, ConversionWorkspace $postBody, array $optParams = [])

Creates a new conversion workspace in a given project and location.

delete(string $name, array $optParams = [])

Deletes a single conversion workspace. (conversionWorkspaces.delete)

describeConversionWorkspaceRevisions(string $conversionWorkspace, array $optParams = [])

Retrieves a list of committed revisions of a specific conversion workspace.

describeDatabaseEntities(string $conversionWorkspace, array $optParams = [])

Describes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted.

get(string $name, array $optParams = [])

Gets details of a single conversion workspace. (conversionWorkspaces.get)

getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

listProjectsLocationsConversionWorkspaces(string $parent, array $optParams = [])

Lists conversion workspaces in a given project and location.

patch(string $name, ConversionWorkspace $postBody, array $optParams = [])

Updates the parameters of a single conversion workspace.

rollback(string $name, RollbackConversionWorkspaceRequest $postBody, array $optParams = [])

Rolls back a conversion workspace to the last committed snapshot.

searchBackgroundJobs(string $conversionWorkspace, array $optParams = [])

Searches/lists the background jobs for a specific conversion workspace. The background jobs are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are a way to expose the data plane jobs log.

seed(string $name, SeedConversionWorkspaceRequest $postBody, array $optParams = [])

Imports a snapshot of the source database into the conversion workspace.

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (conversionWorkspaces.setIamPolicy)

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

Details

Operation apply(string $name, ApplyConversionWorkspaceRequest $postBody, array $optParams = [])

Applies draft tree onto a specific destination database.

(conversionWorkspaces.apply)

Parameters

string $name

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}.

ApplyConversionWorkspaceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation commit(string $name, CommitConversionWorkspaceRequest $postBody, array $optParams = [])

Marks all the data in the conversion workspace as committed.

(conversionWorkspaces.commit)

Parameters

string $name

Required. Name of the conversion workspace resource to commit.

CommitConversionWorkspaceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation convert(string $name, ConvertConversionWorkspaceRequest $postBody, array $optParams = [])

Creates a draft tree schema for the destination database.

(conversionWorkspaces.convert)

Parameters

string $name

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

ConvertConversionWorkspaceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation create(string $parent, ConversionWorkspace $postBody, array $optParams = [])

Creates a new conversion workspace in a given project and location.

(conversionWorkspaces.create)

Parameters

string $parent

Required. The parent which owns this collection of conversion workspaces.

ConversionWorkspace $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation delete(string $name, array $optParams = [])

Deletes a single conversion workspace. (conversionWorkspaces.delete)

Parameters

string $name

Required. Name of the conversion workspace resource to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

DescribeConversionWorkspaceRevisionsResponse describeConversionWorkspaceRevisions(string $conversionWorkspace, array $optParams = [])

Retrieves a list of committed revisions of a specific conversion workspace.

(conversionWorkspaces.describeConversionWorkspaceRevisions)

Parameters

string $conversionWorkspace

Required. Name of the conversion workspace resource whose revisions are listed. Must be in the form of: projects/{projec t}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

array $optParams

Optional parameters.

Return Value

DescribeConversionWorkspaceRevisionsResponse

Exceptions

Exception

DescribeDatabaseEntitiesResponse describeDatabaseEntities(string $conversionWorkspace, array $optParams = [])

Describes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted.

Instead, they are simple data objects describing the structure of the client database. (conversionWorkspaces.describeDatabaseEntities)

Parameters

string $conversionWorkspace

Required. Name of the conversion workspace resource whose database entities are described. Must be in the form of: proje cts/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace }.

array $optParams

Optional parameters.

Return Value

DescribeDatabaseEntitiesResponse

Exceptions

Exception

ConversionWorkspace get(string $name, array $optParams = [])

Gets details of a single conversion workspace. (conversionWorkspaces.get)

Parameters

string $name

Required. Name of the conversion workspace resource to get.

array $optParams

Optional parameters.

Return Value

ConversionWorkspace

Exceptions

Exception

Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

(conversionWorkspaces.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

ListConversionWorkspacesResponse listProjectsLocationsConversionWorkspaces(string $parent, array $optParams = [])

Lists conversion workspaces in a given project and location.

(conversionWorkspaces.listProjectsLocationsConversionWorkspaces)

Parameters

string $parent

Required. The parent which owns this collection of conversion workspaces.

array $optParams

Optional parameters.

Return Value

ListConversionWorkspacesResponse

Exceptions

Exception

Operation patch(string $name, ConversionWorkspace $postBody, array $optParams = [])

Updates the parameters of a single conversion workspace.

(conversionWorkspaces.patch)

Parameters

string $name

Full name of the workspace resource, in the form of: proj ects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspac e}.

ConversionWorkspace $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation rollback(string $name, RollbackConversionWorkspaceRequest $postBody, array $optParams = [])

Rolls back a conversion workspace to the last committed snapshot.

(conversionWorkspaces.rollback)

Parameters

string $name

Required. Name of the conversion workspace resource to roll back to.

RollbackConversionWorkspaceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

SearchBackgroundJobsResponse searchBackgroundJobs(string $conversionWorkspace, array $optParams = [])

Searches/lists the background jobs for a specific conversion workspace. The background jobs are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are a way to expose the data plane jobs log.

(conversionWorkspaces.searchBackgroundJobs)

Parameters

string $conversionWorkspace

Required. Name of the conversion workspace resource whose jobs are listed, in the form of: projects/{project}/locations/ {location}/conversionWorkspaces/{conversion_workspace}.

array $optParams

Optional parameters.

Return Value

SearchBackgroundJobsResponse

Exceptions

Exception

Operation seed(string $name, SeedConversionWorkspaceRequest $postBody, array $optParams = [])

Imports a snapshot of the source database into the conversion workspace.

(conversionWorkspaces.seed)

Parameters

string $name

Name of the conversion workspace resource to seed with new database structure, in the form of: projects/{project}/locations/{locatio n}/conversionWorkspaces/{conversion_workspace}.

SeedConversionWorkspaceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (conversionWorkspaces.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (conversionWorkspaces.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception