2022-12-16
▼ ▲ datamigration.projects.locations.privateConnections.get
Parameter Order: name
HTTP Method: GET
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Required: Yes
Type: string
Description: Required. The name of the private connection to get.
Pattern: ^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$
Description: Gets details of a single private connection.
▼ ▲ datamigration.projects.locations.privateConnections.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Description: Deletes a single Database Migration Service private connection.
Parameters:
requestId
Type: string
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.
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$
Description: Required. The name of the private connection to delete.
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}
Parameter Order: name
Path: v1/{+name}
▼ ▲ datamigration.projects.locations.privateConnections.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
filter
Location: query
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**.
Type: string
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.
Type: string
Location: query
orderBy
Description: Order by fields for the result.
Location: query
Type: string
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent that owns the collection of private connections.
Location: path
Required: Yes
pageSize
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.
Type: integer
Location: query
Path: v1/{+parent}/privateConnections
Parameter Order: parent
HTTP Method: GET
Description: Retrieves a list of private connections in a given project and location.
▼ ▲ datamigration.projects.locations.privateConnections.create
HTTP Method: POST
Path: v1/{+parent}/privateConnections
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections
Description: Creates a new private connection in a given project and location.
Parameter Order: parent
Parameters:
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
Description: Required. The private connection identifier.
Type: string
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent that owns the collection of PrivateConnections.
Required: Yes
Type: string
▼ ▲ datamigration.projects.locations.conversionWorkspaces.mappingRules.import
Description: Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.
Parameter Order: parent
Parameters:
parent
Required: Yes
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}.
Location: path
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules:import
Path: v1/{+parent}/mappingRules:import
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ datamigration.projects.locations.conversionWorkspaces.commit
Description: Marks all the data in the conversion workspace as committed.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:commit
Parameter Order: name
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Type: string
Location: path
Description: Required. Name of the conversion workspace resource to commit.
HTTP Method: POST
Path: v1/{+name}:commit
▼ ▲ datamigration.projects.locations.conversionWorkspaces.convert
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Description: Name of the conversion workspace resource to convert in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Location: path
Path: v1/{+name}:convert
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:convert
HTTP Method: POST
Parameter Order: name
Description: Creates a draft tree schema for the destination database.
▼ ▲ datamigration.projects.locations.conversionWorkspaces.searchBackgroundJobs
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:searchBackgroundJobs
Parameters:
conversionWorkspace
Required: Yes
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}.
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Type: string
completedUntilTime
Location: query
Type: string
Format: google-datetime
Description: Optional. If supplied, will only return jobs that completed until (not including) the given timestamp.
returnMostRecentPerJobType
Description: Optional. Whether or not to return just the most recent job per job type
Type: boolean
Location: query
maxSize
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.
Format: int32
Type: integer
Location: query
HTTP Method: GET
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.
Parameter Order: conversionWorkspace
Path: v1/{+conversionWorkspace}:searchBackgroundJobs
▼ ▲ datamigration.projects.locations.conversionWorkspaces.apply
Description: Apply draft tree onto a specific destination database
HTTP Method: POST
Path: v1/{+name}:apply
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:apply
Parameters:
name
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
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Type: string
▼ ▲ datamigration.projects.locations.conversionWorkspaces.create
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces
Path: v1/{+parent}/conversionWorkspaces
Description: Creates a new conversion workspace in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
requestId
Type: string
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.
conversionWorkspaceId
Location: query
Description: Required. The ID of the conversion workspace to create.
Type: string
parent
Required: Yes
Type: string
Description: Required. The parent, which owns this collection of conversion workspaces.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
HTTP Method: POST
▼ ▲ datamigration.projects.locations.conversionWorkspaces.delete
Description: Deletes a single conversion workspace.
Path: v1/{+name}
Parameters:
name
Location: path
Required: Yes
Description: Required. Name of the conversion workspace resource to delete.
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Type: string
requestId
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.
Location: query
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ datamigration.projects.locations.conversionWorkspaces.rollback
Path: v1/{+name}:rollback
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:rollback
HTTP Method: POST
Parameter Order: name
Parameters:
name
Type: string
Required: Yes
Location: path
Description: Required. Name of the conversion workspace resource to rollback to.
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Rollbacks a conversion workspace to the last committed spanshot.
▼ ▲ datamigration.projects.locations.conversionWorkspaces.get
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}
HTTP Method: GET
Parameters:
name
Type: string
Location: path
Description: Required. Name of the conversion workspace resource to get.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single conversion workspace.
▼ ▲ datamigration.projects.locations.conversionWorkspaces.patch
HTTP Method: PATCH
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}
Path: v1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Location: path
Type: string
Required: Yes
Description: Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
updateMask
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
Format: google-fieldmask
requestId
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.
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single conversion workspace.
▼ ▲ datamigration.projects.locations.conversionWorkspaces.describeConversionWorkspaceRevisions
Description: Retrieves a list of committed revisions of a specific conversion workspace.
Parameter Order: conversionWorkspace
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:describeConversionWorkspaceRevisions
HTTP Method: GET
Path: v1/{+conversionWorkspace}:describeConversionWorkspaceRevisions
Parameters:
conversionWorkspace
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
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
Location: path
Required: Yes
commitId
Location: query
Type: string
Description: Optional filter to request a specific commit id
▼ ▲ datamigration.projects.locations.conversionWorkspaces.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces
Parameters:
pageSize
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.
Type: integer
Location: query
Format: int32
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.
parent
Description: Required. The parent, which owns this collection of conversion workspaces.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
filter
Location: query
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
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/conversionWorkspaces
Parameter Order: parent
HTTP Method: GET
Description: Lists conversion workspaces in a given project and location.
▼ ▲ datamigration.projects.locations.conversionWorkspaces.describeDatabaseEntities
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:describeDatabaseEntities
Parameter Order: conversionWorkspace
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
tree
Type: string
Enum:
Description: The tree to fetch
Enum Descriptions:
Location: query
pageSize
Type: integer
Location: query
Description: The maximum number of entities to return. The service may return fewer than this value.
Format: int32
filter
Description: Filter the returned entities based on AIP-160 standard
Location: query
Type: string
conversionWorkspace
Type: string
Required: Yes
Location: path
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}.
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
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
Type: boolean
commitId
Location: query
Type: string
Description: Request a specific commit id. If not specified, the entities from the latest commit are returned.
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
▼ ▲ datamigration.projects.locations.conversionWorkspaces.seed
Parameter Order: name
Path: v1/{+name}:seed
Description: Imports a snapshot of the source database into the conversion workspace.
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$
Location: path
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}.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:seed
▼ ▲ datamigration.projects.locations.connectionProfiles.create
Parameters:
validateOnly
Type: boolean
Description: Optional. Only validate the connection profile, but don't create any resources. The default is false. Only supported for Oracle connection profiles.
Location: query
skipValidation
Type: boolean
Location: query
Description: Optional. Create the connection profile without validating it. The default is false. Only supported for Oracle connection profiles.
▼ ▲ datamigration.projects.locations.connectionProfiles.patch
Parameters:
skipValidation
Location: query
Type: boolean
Description: Optional. Update the connection profile without validating it. The default is false. Only supported for Oracle connection profiles.
validateOnly
Location: query
Type: boolean
Description: Optional. Only validate the connection profile, but don't update any resources. The default is false. Only supported for Oracle connection profiles.