REST Resource: projects.locations.conversionWorkspaces

Resource: ConversionWorkspace

The main conversion workspace resource entity.

JSON representation
{
  "name": string,
  "source": {
    object (DatabaseEngineInfo)
  },
  "destination": {
    object (DatabaseEngineInfo)
  },
  "globalSettings": {
    string: string,
    ...
  },
  "hasUncommittedChanges": boolean,
  "latestCommitId": string,
  "latestCommitTime": string,
  "createTime": string,
  "updateTime": string,
  "displayName": string
}
Fields
name

string

Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversionWorkspace}.

source

object (DatabaseEngineInfo)

Required. The source engine details.

destination

object (DatabaseEngineInfo)

Required. The destination engine details.

globalSettings

map (key: string, value: string)

Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

hasUncommittedChanges

boolean

Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed).

latestCommitId

string

Output only. The latest commit ID.

latestCommitTime

string (Timestamp format)

Output only. The timestamp when the workspace was committed.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

createTime

string (Timestamp format)

Output only. The timestamp when the workspace resource was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The timestamp when the workspace resource was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

displayName

string

Optional. The display name for the workspace.

DatabaseEngineInfo

The type and version of a source or destination database.

JSON representation
{
  "engine": enum (DatabaseEngine),
  "version": string
}
Fields
engine

enum (DatabaseEngine)

Required. Engine type.

version

string

Required. Engine version, for example "12.c.1".

Methods

apply

Applies draft tree onto a specific destination database.

commit

Marks all the data in the conversion workspace as committed.

convert

Creates a draft tree schema for the destination database.

create

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

delete

Deletes a single conversion workspace.

describeConversionWorkspaceRevisions

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

describeDatabaseEntities

Describes the database entities tree for a specific conversion workspace and a specific tree type.

get

Gets details of a single conversion workspace.

getIamPolicy

Gets the access control policy for a resource.

list

Lists conversion workspaces in a given project and location.

patch

Updates the parameters of a single conversion workspace.

rollback

Rolls back a conversion workspace to the last committed snapshot.

searchBackgroundJobs

Searches/lists the background jobs for a specific conversion workspace.

seed

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

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.