2022-12-17
▼ ▲ datamigration.projects.locations.conversionWorkspaces.mappingRules.import
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules:import
HTTP Method: POST
Description: Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.
Path: v1/{+parent}/mappingRules:import
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Location: path
Description: Required. Name of the conversion workspace resource to import the rules to in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
▼ ▲ datamigration.projects.locations.conversionWorkspaces.searchBackgroundJobs
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:searchBackgroundJobs
Parameters:
maxSize
Format: int32
Description: Optional. The maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 100 jobs will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Type: integer
Location: query
conversionWorkspace
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Description: Required. Name of the conversion workspace resource whos jobs are listed. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Required: Yes
Type: string
completedUntilTime
Description: Optional. If supplied, will only return jobs that completed until (not including) the given timestamp.
Type: string
Location: query
Format: google-datetime
returnMostRecentPerJobType
Type: boolean
Location: query
Description: Optional. Whether or not to return just the most recent job per job type
Parameter Order: conversionWorkspace
Path: v1/{+conversionWorkspace}:searchBackgroundJobs
Description: Use this method to search/list the background jobs for a specific conversion workspace. The background jobs are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are a way to expose the data plane jobs log.
HTTP Method: GET
▼ ▲ datamigration.projects.locations.conversionWorkspaces.seed
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:seed
Description: Imports a snapshot of the source database into the conversion workspace.
Path: v1/{+name}:seed
HTTP Method: POST
Parameters:
name
Required: Yes
Description: Name of the conversion workspace resource to seed with new database structure. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Type: string
Location: path
▼ ▲ datamigration.projects.locations.conversionWorkspaces.describeConversionWorkspaceRevisions
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:describeConversionWorkspaceRevisions
Path: v1/{+conversionWorkspace}:describeConversionWorkspaceRevisions
Parameter Order: conversionWorkspace
Parameters:
commitId
Description: Optional filter to request a specific commit id
Location: query
Type: string
conversionWorkspace
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Type: string
Location: path
Description: Required. Name of the conversion workspace resource whose revisions are listed. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Required: Yes
Description: Retrieves a list of committed revisions of a specific conversion workspace.
▼ ▲ datamigration.projects.locations.conversionWorkspaces.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces
Path: v1/{+parent}/conversionWorkspaces
Parameters:
pageSize
Location: query
Format: int32
Type: integer
Description: The maximum number of conversion workspaces to return. The service may return fewer than this value. If unspecified, at most 50 sets will be returned.
pageToken
Location: query
Description: The nextPageToken value received in the previous call to conversionWorkspaces.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 conversionWorkspaces.list must match the call that provided the page token.
Type: string
filter
Description: A filter expression that filters conversion workspaces listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list conversion workspaces created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify **source.version = "12.c.1"** to select all conversion workspaces with source database version equal to 12.c.1
Location: query
Type: string
parent
Location: path
Description: Required. The parent, which owns this collection of conversion workspaces.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Lists conversion workspaces in a given project and location.
Parameter Order: parent
▼ ▲ datamigration.projects.locations.conversionWorkspaces.convert
HTTP Method: POST
Description: Creates a draft tree schema for the destination database.
Path: v1/{+name}:convert
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:convert
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Required: Yes
Type: string
Location: path
Description: Name of the conversion workspace resource to convert in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Parameter Order: name
▼ ▲ datamigration.projects.locations.conversionWorkspaces.get
Description: Gets details of a single conversion workspace.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Location: path
Required: Yes
Description: Required. Name of the conversion workspace resource to get.
Parameter Order: name
Path: v1/{+name}
▼ ▲ datamigration.projects.locations.conversionWorkspaces.describeDatabaseEntities
Description: Use this method to describe the database entities tree for a specific conversion workspace and a specific tree type. The DB Entities are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are simple data objects describing the structure of the client database.
Path: v1/{+conversionWorkspace}:describeDatabaseEntities
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:describeDatabaseEntities
Parameters:
filter
Type: string
Description: Filter the returned entities based on AIP-160 standard
Location: query
pageSize
Location: query
Type: integer
Format: int32
Description: The maximum number of entities to return. The service may return fewer than this value.
tree
Enum:
Description: The tree to fetch
Location: query
Type: string
Enum Descriptions:
commitId
Location: query
Description: Request a specific commit id. If not specified, the entities from the latest commit are returned.
Type: string
conversionWorkspace
Description: Required. Name of the conversion workspace resource whose DB entities are described in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Required: Yes
Type: string
uncommitted
Type: boolean
Description: Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.
Location: query
pageToken
Location: query
Description: The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, 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.describeDatabaseEntities must match the call that provided the page token.
Type: string
Parameter Order: conversionWorkspace
▼ ▲ datamigration.projects.locations.conversionWorkspaces.delete
Description: Deletes a single conversion workspace.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}
HTTP Method: DELETE
Parameters:
requestId
Description: A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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
name
Description: Required. Name of the conversion workspace resource to delete.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
▼ ▲ datamigration.projects.locations.conversionWorkspaces.rollback
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:rollback
Parameter Order: name
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:rollback
Parameters:
name
Description: Required. Name of the conversion workspace resource to rollback to.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Type: string
Description: Rollbacks a conversion workspace to the last committed spanshot.
▼ ▲ datamigration.projects.locations.conversionWorkspaces.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}
Description: Updates the parameters of a single conversion workspace.
HTTP Method: PATCH
Parameters:
requestId
Description: A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.
Type: string
Location: query
name
Description: Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Location: path
Type: string
updateMask
Format: google-fieldmask
Description: Required. Field mask is used to specify the fields to be overwritten in the conversion workspace resource by the update.
Location: query
Type: string
▼ ▲ datamigration.projects.locations.conversionWorkspaces.commit
Path: v1/{+name}:commit
Parameters:
name
Description: Required. Name of the conversion workspace resource to commit.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:commit
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Marks all the data in the conversion workspace as committed.
▼ ▲ datamigration.projects.locations.conversionWorkspaces.apply
Path: v1/{+name}:apply
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:apply
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Required: Yes
Location: path
Description: Required. Name of the conversion workspace resource to apply draft to destination for. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
HTTP Method: POST
Description: Apply draft tree onto a specific destination database
▼ ▲ datamigration.projects.locations.conversionWorkspaces.create
Path: v1/{+parent}/conversionWorkspaces
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new conversion workspace in a given project and location.
HTTP Method: POST
Parameter Order: parent
Parameters:
requestId
Description: A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.
Type: string
Location: query
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent, which owns this collection of conversion workspaces.
Required: Yes
Type: string
conversionWorkspaceId
Description: Required. The ID of the conversion workspace to create.
Location: query
Type: string
▼ ▲ datamigration.projects.locations.privateConnections.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single private connection.
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$
Required: Yes
Description: Required. The name of the private connection to get.
HTTP Method: GET
Parameter Order: name
▼ ▲ datamigration.projects.locations.privateConnections.create
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections
Parameters:
parent
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent that owns the collection of PrivateConnections.
Type: string
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 will be 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.
privateConnectionId
Location: query
Type: string
Description: Required. The private connection identifier.
Path: v1/{+parent}/privateConnections
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new private connection in a given project and location.
Parameter Order: parent
HTTP Method: POST
▼ ▲ datamigration.projects.locations.privateConnections.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections
Path: v1/{+parent}/privateConnections
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
pageSize
Description: Maximum number of private connections to return. If unspecified, at most 50 private connections that will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Format: int32
Type: integer
parent
Description: Required. The parent that owns the collection of private connections.
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
pageToken
Description: Page token received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateConnections` must match the call that provided the page token.
Location: query
Type: string
filter
Type: string
Description: A filter expression that filters private connections listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list private connections created this year by specifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**.
Location: query
orderBy
Type: string
Description: Order by fields for the result.
Location: query
Description: Retrieves a list of private connections in a given project and location.
HTTP Method: GET
▼ ▲ datamigration.projects.locations.privateConnections.delete
Description: Deletes a single Database Migration Service private connection.
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the private connection to delete.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$
Required: Yes
requestId
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 will be 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
Parameter Order: name
▼ ▲ datamigration.projects.locations.connectionProfiles.patch
Parameters:
skipValidation
Description: Optional. Update the connection profile without validating it. The default is false. Only supported for Oracle connection profiles.
Type: boolean
Location: query
validateOnly
Description: Optional. Only validate the connection profile, but don't update any resources. The default is false. Only supported for Oracle connection profiles.
Type: boolean
Location: query
▼ ▲ datamigration.projects.locations.connectionProfiles.create
Parameters:
validateOnly
Location: query
Description: Optional. Only validate the connection profile, but don't create any resources. The default is false. Only supported for Oracle connection profiles.
Type: boolean
skipValidation
Type: boolean
Description: Optional. Create the connection profile without validating it. The default is false. Only supported for Oracle connection profiles.
Location: query
▼ ▲ datamigration.projects.locations.connectionProfiles.create
Parameters:
skipValidation
Location: query
Description: Optional. Create the connection profile without validating it. The default is false. Only supported for Oracle connection profiles.
Type: boolean
validateOnly
Location: query
Description: Optional. Only validate the connection profile, but don't create any resources. The default is false. Only supported for Oracle connection profiles.
Type: boolean
▼ ▲ datamigration.projects.locations.connectionProfiles.patch
Parameters:
validateOnly
Description: Optional. Only validate the connection profile, but don't update any resources. The default is false. Only supported for Oracle connection profiles.
Location: query
Type: boolean
skipValidation
Location: query
Description: Optional. Update the connection profile without validating it. The default is false. Only supported for Oracle connection profiles.
Type: boolean
▼ ▲ datamigration.projects.locations.conversionWorkspaces.searchBackgroundJobs
HTTP Method: GET
Path: v1/{+conversionWorkspace}:searchBackgroundJobs
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:searchBackgroundJobs
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Use this method to search/list the background jobs for a specific conversion workspace. The background jobs are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are a way to expose the data plane jobs log.
Parameters:
conversionWorkspace
Location: path
Description: Required. Name of the conversion workspace resource whos jobs are listed. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
returnMostRecentPerJobType
Type: boolean
Description: Optional. Whether or not to return just the most recent job per job type
Location: query
maxSize
Type: integer
Description: Optional. The maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 100 jobs will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Location: query
Format: int32
completedUntilTime
Type: string
Description: Optional. If supplied, will only return jobs that completed until (not including) the given timestamp.
Location: query
Format: google-datetime
Parameter Order: conversionWorkspace
▼ ▲ datamigration.projects.locations.conversionWorkspaces.commit
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:commit
Parameter Order: name
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:commit
Description: Marks all the data in the conversion workspace as committed.
Parameters:
name
Description: Required. Name of the conversion workspace resource to commit.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Required: Yes
Location: path
▼ ▲ datamigration.projects.locations.conversionWorkspaces.rollback
HTTP Method: POST
Parameter Order: name
Path: v1/{+name}:rollback
Description: Rollbacks a conversion workspace to the last committed spanshot.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:rollback
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Location: path
Required: Yes
Type: string
Description: Required. Name of the conversion workspace resource to rollback to.
▼ ▲ datamigration.projects.locations.conversionWorkspaces.convert
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a draft tree schema for the destination database.
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Type: string
Required: Yes
Description: Name of the conversion workspace resource to convert in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Parameter Order: name
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:convert
Path: v1/{+name}:convert
▼ ▲ datamigration.projects.locations.conversionWorkspaces.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}
Parameter Order: name
Description: Gets details of a single conversion workspace.
Parameters:
name
Description: Required. Name of the conversion workspace resource to get.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Type: string
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
▼ ▲ datamigration.projects.locations.conversionWorkspaces.list
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/conversionWorkspaces
Parameters:
parent
Required: Yes
Type: string
Location: path
Description: Required. The parent, which owns this collection of conversion workspaces.
Pattern: ^projects/[^/]+/locations/[^/]+$
pageToken
Type: string
Location: query
Description: The nextPageToken value received in the previous call to conversionWorkspaces.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 conversionWorkspaces.list must match the call that provided the page token.
pageSize
Type: integer
Location: query
Description: The maximum number of conversion workspaces to return. The service may return fewer than this value. If unspecified, at most 50 sets will be returned.
Format: int32
filter
Type: string
Description: A filter expression that filters conversion workspaces listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list conversion workspaces created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify **source.version = "12.c.1"** to select all conversion workspaces with source database version equal to 12.c.1
Location: query
HTTP Method: GET
Description: Lists conversion workspaces in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces
▼ ▲ datamigration.projects.locations.conversionWorkspaces.describeDatabaseEntities
HTTP Method: GET
Description: Use this method to describe the database entities tree for a specific conversion workspace and a specific tree type. The DB Entities are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are simple data objects describing the structure of the client database.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:describeDatabaseEntities
Parameter Order: conversionWorkspace
Path: v1/{+conversionWorkspace}:describeDatabaseEntities
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
commitId
Location: query
Description: Request a specific commit id. If not specified, the entities from the latest commit are returned.
Type: string
filter
Type: string
Description: Filter the returned entities based on AIP-160 standard
Location: query
conversionWorkspace
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Description: Required. Name of the conversion workspace resource whose DB entities are described in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Required: Yes
Location: path
Type: string
tree
Type: string
Enum Descriptions:
Enum:
Description: The tree to fetch
Location: query
pageSize
Location: query
Format: int32
Description: The maximum number of entities to return. The service may return fewer than this value.
Type: integer
pageToken
Description: The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, 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.describeDatabaseEntities must match the call that provided the page token.
Location: query
Type: string
uncommitted
Type: boolean
Location: query
Description: Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.
▼ ▲ datamigration.projects.locations.conversionWorkspaces.seed
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:seed
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1/{+name}:seed
HTTP Method: POST
Description: Imports a snapshot of the source database into the conversion workspace.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Type: string
Required: Yes
Description: Name of the conversion workspace resource to seed with new database structure. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Location: path
▼ ▲ datamigration.projects.locations.conversionWorkspaces.create
Parameters:
parent
Description: Required. The parent, which owns this collection of conversion workspaces.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
conversionWorkspaceId
Location: query
Description: Required. The ID of the conversion workspace to create.
Type: string
requestId
Description: A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new conversion workspace in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces
Parameter Order: parent
HTTP Method: POST
Path: v1/{+parent}/conversionWorkspaces
▼ ▲ datamigration.projects.locations.conversionWorkspaces.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}
Description: Deletes a single conversion workspace.
Parameter Order: name
HTTP Method: DELETE
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Location: path
Description: Required. Name of the conversion workspace resource to delete.
Required: Yes
requestId
Location: query
Type: string
Description: A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.
▼ ▲ datamigration.projects.locations.conversionWorkspaces.patch
Parameters:
name
Description: Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Required: Yes
Location: path
requestId
Location: query
Description: A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.
Type: string
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the conversion workspace resource by the update.
Location: query
Format: google-fieldmask
Type: string
Description: Updates the parameters of a single conversion workspace.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}
HTTP Method: PATCH
Path: v1/{+name}
Parameter Order: name
▼ ▲ datamigration.projects.locations.conversionWorkspaces.describeConversionWorkspaceRevisions
Parameters:
commitId
Description: Optional filter to request a specific commit id
Type: string
Location: query
conversionWorkspace
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Location: path
Required: Yes
Description: Required. Name of the conversion workspace resource whose revisions are listed. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+conversionWorkspace}:describeConversionWorkspaceRevisions
Description: Retrieves a list of committed revisions of a specific conversion workspace.
Parameter Order: conversionWorkspace
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:describeConversionWorkspaceRevisions
HTTP Method: GET
▼ ▲ datamigration.projects.locations.conversionWorkspaces.apply
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:apply
HTTP Method: POST
Path: v1/{+name}:apply
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Apply draft tree onto a specific destination database
Parameters:
name
Required: Yes
Type: string
Description: Required. Name of the conversion workspace resource to apply draft to destination for. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Parameter Order: name
▼ ▲ datamigration.projects.locations.conversionWorkspaces.mappingRules.import
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/mappingRules:import
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules:import
Description: Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.
Parameter Order: parent
HTTP Method: POST
Parameters:
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Description: Required. Name of the conversion workspace resource to import the rules to in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Type: string
▼ ▲ datamigration.projects.locations.privateConnections.create
Path: v1/{+parent}/privateConnections
HTTP Method: POST
Parameters:
privateConnectionId
Location: query
Description: Required. The private connection identifier.
Type: string
requestId
Location: query
Description: Optional. A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent that owns the collection of PrivateConnections.
Location: path
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections
Parameter Order: parent
Description: Creates a new private connection in a given project and location.
▼ ▲ datamigration.projects.locations.privateConnections.list
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections
Path: v1/{+parent}/privateConnections
Parameters:
filter
Location: query
Type: string
Description: A filter expression that filters private connections listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list private connections created this year by specifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**.
pageSize
Location: query
Type: integer
Format: int32
Description: Maximum number of private connections to return. If unspecified, at most 50 private connections that will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
parent
Type: string
Description: Required. The parent that owns the collection of private connections.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
pageToken
Type: string
Location: query
Description: Page token received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateConnections` must match the call that provided the page token.
orderBy
Location: query
Description: Order by fields for the result.
Type: string
Description: Retrieves a list of private connections in a given project and location.
HTTP Method: GET
▼ ▲ datamigration.projects.locations.privateConnections.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}
Path: v1/{+name}
Parameters:
name
Type: string
Required: Yes
Location: path
Description: Required. The name of the private connection to delete.
Pattern: ^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$
requestId
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 will be 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
HTTP Method: DELETE
Description: Deletes a single Database Migration Service private connection.
▼ ▲ datamigration.projects.locations.privateConnections.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}
HTTP Method: GET
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$
Type: string
Required: Yes
Description: Required. The name of the private connection to get.
Parameter Order: name
Description: Gets details of a single private connection.