Database Migration API (datamigration:v1)

Additions

Methods


• ▼ ▲ datamigration.projects.locations.conversionWorkspaces.fetchIssues

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

  Parameters :

  conversionWorkspace

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

  Description : Required. Conversion workspace with issues to fetch. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

  Required : Yes

  Location : path

  Type : string

  tree

  Description : Optional. The tree to fetch issues from. If not specified, source tree is assumed.

  Enum :

  • DB_TREE_TYPE_UNSPECIFIED
  • SOURCE
  • DRAFT

  Enum Descriptions :

  • Unspecified tree type.
  • Returns seed and conversion issues
  • Returns apply issues.

  Type : string

  Location : query

  pageToken

  Description : Optional. The FetchIssuesResponse.next_page_token value received in the previous call to FetchIssues, 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 FetchIssues must match the call that provided the page token, except for the page_size parameter.

  Type : string

  Location : query

  allIssues

  Description : Optional. If 'true', gets all issues matching the filter. Otherwise, for each entity only the issues matching the DdlKind chosen for application on the destination are returned.

  Type : boolean

  Location : query

  pageSize

  Type : integer

  Format : int32

  Location : query

  Description : Optional. The maximum number of issues to return. The service may return fewer issues than the value specifies.

  filter

  Location : query

  Description : Optional. AIP-160 standard filter. Supporting both entity and issue fields. Supported fields: - `name` / `fullname`: The entity full name. - `type`: The entity type (e.g. `TABLE`, `VIEW`, `INDEX`, `TRIGGER`). - `ddlkind`: The kind of DDL (e.g. `DDL_KIND_SOURCE`, `DDL_KIND_AI`, `DDL_KIND_DETERMINISTIC`). - `issue.severity`: The severity of the issue (e.g. `INFO`, `WARNING`, `ERROR`). - `issue.state`: The state of the issue (e.g. `OPEN`, `RESOLVED`). - `issue.origin`: The origin of the issue (e.g. `DETERMINISTIC`, `AI`). - `issue.category_id`: The category ID of the issue. - `issue.group_id`: The group ID of the issue.

  Type : string

  Path : v1/{+conversionWorkspace}:fetchIssues

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

  HTTP Method : GET

  Parameter Order : conversionWorkspace

  Description : List issues of conversion workspace operations e.g. conversion.

• ▼ ▲ datamigration.projects.locations.conversionWorkspaces.fetchEntitiesStatusView

  Description : An internal, RPC only method that returns a list of the (filtered) entities with minimal information required for the entities tree view.

  HTTP Method : GET

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

  Path : v1/{+conversionWorkspace}:fetchEntitiesStatusView

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

  Parameter Order : conversionWorkspace

  Parameters :

  pageToken

  Location : query

  Type : string

  Description : Optional. The nextPageToken value received in the previous call to conversionWorkspace.FetchEntitiesStatusView, 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 conversionWorkspace.FetchEntitiesStatusView must match the call that provided the page token, except for the page_size parameter.

  filter

  Description : Optional. Filter the returned entities based on AIP-160 standard.

  Type : string

  Location : query

  fetchView

  Type : string

  Location : query

  Description : Optional. The view to fetch. If not specified, FULL is used.

  Enum :

  • FETCH_VIEW_UNSPECIFIED
  • FULL
  • SUMMARY
  • FULL_WITH_DEPENDENCIES

  Enum Descriptions :

  • Unspecified view. Defaults to FULL.
  • Get all entities matching the filter.
  • Each schema will have one entity per (non sub) type with a dummy name that will contain the aggregated information for all entities of that type. Counters like number of statements and issues will be aggregated accordingly.
  • Same as FULL plus dependency information.

  tree

  Enum :

  • DB_TREE_TYPE_UNSPECIFIED
  • SOURCE_TREE
  • DRAFT_TREE

  Enum Descriptions :

  • Unspecified tree type.
  • The source database tree.
  • The draft database tree.

  Description : Required. The tree to fetch.

  Location : query

  Type : string

  conversionWorkspace

  Location : path

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

  Required : Yes

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

  Type : string

  pageSize

  Description : Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies. Default is 100000.

  Format : int32

  Location : query

  Type : integer

• ▼ ▲ datamigration.projects.locations.conversionWorkspaces.setDraftEntityDdl

  HTTP Method : POST

  Description : Updates the draft DDL of an entity.

  Path : v1/{+conversionWorkspace}:setDraftEntityDdl

  Parameters :

  conversionWorkspace

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

  Location : path

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

  Required : Yes

  Type : string

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

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

  Parameter Order : conversionWorkspace