Database Migration API (datamigration:v1)

▼ ▲ datamigration.projects.locations.conversionWorkspaces.describeDatabaseEntities

Parameters:

view

Description: Optional. Results view based on AIP-157

Enum Descriptions:

• Unspecified view. Defaults to basic view.
• Default view. Does not return DDLs or Issues.
• Return full entity details including mappings, ddl and issues.
• Top-most (Database, Schema) nodes which are returned contains summary details for their decendents such as the number of entities per type and issues rollups. When this view is used, only a single page of result is returned and the page_size property of the request is ignored. The returned page will only include the top-most node types.

Location: query

Enum:

• DATABASE_ENTITY_VIEW_UNSPECIFIED
• DATABASE_ENTITY_VIEW_BASIC
• DATABASE_ENTITY_VIEW_FULL
• DATABASE_ENTITY_VIEW_ROOT_SUMMARY

Type: string

▼ ▲ datamigration.projects.locations.conversionWorkspaces.mappingRules.create

Parameter Order: parent

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

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules

Parameters:

parent

Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$

Type: string

Required: Yes

Description: Required. The parent which owns this collection of mapping rules.

Location: path

mappingRuleId

Location: query

Type: string

Description: Required. The ID of the rule to create.

requestId

Description: A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Location: query

Type: string

HTTP Method: POST

Description: Creates a new mapping rule for a given conversion workspace.

Path: v1/{+parent}/mappingRules

▼ ▲ datamigration.projects.locations.conversionWorkspaces.mappingRules.delete

HTTP Method: DELETE

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules/{mappingRulesId}

Parameter Order: name

Parameters:

name

Type: string

Required: Yes

Description: Required. Name of the mapping rule resource to delete.

Location: path

Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+/mappingRules/[^/]+$

requestId

Location: query

Type: string

Description: Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

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

Path: v1/{+name}

Description: Deletes a single mapping rule.

▼ ▲ datamigration.projects.locations.conversionWorkspaces.mappingRules.get

Parameter Order: name

Path: v1/{+name}

Description: Gets the details of a mapping rule.

Parameters:

name

Required: Yes

Location: path

Description: Required. Name of the mapping rule resource to get. Example: conversionWorkspaces/123/mappingRules/rule123 In order to retrieve a previous revision of the mapping rule, also provide the revision ID. Example: conversionWorkspace/123/mappingRules/rule123@c7cfa2a8c7cfa2a8c7cfa2a8c7cfa2a8

Type: string

Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+/mappingRules/[^/]+$

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

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules/{mappingRulesId}

HTTP Method: GET

▼ ▲ datamigration.projects.locations.conversionWorkspaces.mappingRules.list

Parameter Order: parent

Description: Lists the mapping rules for a specific conversion workspace.

HTTP Method: GET

Path: v1/{+parent}/mappingRules

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

Parameters:

parent

Type: string

Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$

Location: path

Required: Yes

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

pageToken

Location: query

Description: The nextPageToken value received in the previous call to mappingRules.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to mappingRules.list must match the call that provided the page token.

Type: string

pageSize

Location: query

Description: The maximum number of rules to return. The service may return fewer than this value.

Type: integer

Format: int32

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules

▼ ▲ datamigration.projects.locations.conversionWorkspaces.mappingRules.create

Parameter Order: parent

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

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules

Parameters:

parent

Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$

Type: string

Required: Yes

Description: Required. The parent which owns this collection of mapping rules.

Location: path

mappingRuleId

Location: query

Type: string

Description: Required. The ID of the rule to create.

requestId

Description: A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Location: query

Type: string

HTTP Method: POST

Description: Creates a new mapping rule for a given conversion workspace.

Path: v1/{+parent}/mappingRules

▼ ▲ datamigration.projects.locations.conversionWorkspaces.mappingRules.delete

HTTP Method: DELETE

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules/{mappingRulesId}

Parameter Order: name

Parameters:

name

Type: string

Required: Yes

Description: Required. Name of the mapping rule resource to delete.

Location: path

Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+/mappingRules/[^/]+$

requestId

Location: query

Type: string

Description: Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

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

Path: v1/{+name}

Description: Deletes a single mapping rule.

▼ ▲ datamigration.projects.locations.conversionWorkspaces.mappingRules.get

Parameter Order: name

Path: v1/{+name}

Description: Gets the details of a mapping rule.

Parameters:

name

Required: Yes

Location: path

Description: Required. Name of the mapping rule resource to get. Example: conversionWorkspaces/123/mappingRules/rule123 In order to retrieve a previous revision of the mapping rule, also provide the revision ID. Example: conversionWorkspace/123/mappingRules/rule123@c7cfa2a8c7cfa2a8c7cfa2a8c7cfa2a8

Type: string

Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+/mappingRules/[^/]+$

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

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules/{mappingRulesId}

HTTP Method: GET

▼ ▲ datamigration.projects.locations.conversionWorkspaces.mappingRules.list

Parameter Order: parent

Description: Lists the mapping rules for a specific conversion workspace.

HTTP Method: GET

Path: v1/{+parent}/mappingRules

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

Parameters:

parent

Type: string

Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$

Location: path

Required: Yes

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

pageToken

Location: query

Description: The nextPageToken value received in the previous call to mappingRules.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to mappingRules.list must match the call that provided the page token.

Type: string

pageSize

Location: query

Description: The maximum number of rules to return. The service may return fewer than this value.

Type: integer

Format: int32

Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules

▼ ▲ datamigration.projects.locations.conversionWorkspaces.describeDatabaseEntities

Parameters:

view

Description: Optional. Results view based on AIP-157

Enum Descriptions:

• Unspecified view. Defaults to basic view.
• Default view. Does not return DDLs or Issues.
• Return full entity details including mappings, ddl and issues.
• Top-most (Database, Schema) nodes which are returned contains summary details for their decendents such as the number of entities per type and issues rollups. When this view is used, only a single page of result is returned and the page_size property of the request is ignored. The returned page will only include the top-most node types.

Location: query

Enum:

• DATABASE_ENTITY_VIEW_UNSPECIFIED
• DATABASE_ENTITY_VIEW_BASIC
• DATABASE_ENTITY_VIEW_FULL
• DATABASE_ENTITY_VIEW_ROOT_SUMMARY

Type: string