Database Migration API: projects. Manage Cloud Database Migration Service resources on Google Cloud Platform. See: https://cloud.google.com/database-migration/api/reference/rest/v1/projects
Database Migration API: projects. Manage Cloud Database Migration Service resources on Google Cloud Platform. See: https://cloud.google.com/database-migration/api/reference/rest/v1/projects
(locations-connectionProfiles-create$ auth parameters body)
Required parameters: parent
Optional parameters: connectionProfileId, requestId, validateOnly, skipValidation
Body:
{:labels {}, :alloydb {:clusterId string, :settings AlloyDbSettings}, :postgresql {:ssl SslConfig, :password string, :networkArchitecture string, :privateServiceConnectConnectivity PrivateServiceConnectConnectivity, :username string, :staticIpConnectivity StaticIpConnectivity, :cloudSqlId string, :port integer, :host string, :alloydbClusterId string, :passwordSet boolean}, :displayName string, :name string, :createTime string, :cloudsql {:cloudSqlId string, :settings CloudSqlSettings, :privateIp string, :publicIp string, :additionalPublicIp string}, :oracle {:ssl SslConfig, :privateConnectivity PrivateConnectivity, :password string, :username string, :forwardSshConnectivity ForwardSshTunnelConnectivity, :port integer, :host string, :databaseService string, :staticServiceIpConnectivity StaticServiceIpConnectivity, :passwordSet boolean}, :state string, :updateTime string, :error {:code integer, :message string, :details [{}]}, :provider string, :mysql {:host string, :port integer, :username string, :password string, :passwordSet boolean, :ssl SslConfig, :cloudSqlId string}, :sqlserver {:ssl SslConfig, :privateConnectivity PrivateConnectivity, :password string, :privateServiceConnectConnectivity PrivateServiceConnectConnectivity, :username string, :staticIpConnectivity StaticIpConnectivity, :forwardSshConnectivity ForwardSshTunnelConnectivity, :cloudSqlId string, :port integer, :backups SqlServerBackups, :host string, :passwordSet boolean}}
Creates a new connection profile in a given project and location.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/connectionProfiles/create Required parameters: parent Optional parameters: connectionProfileId, requestId, validateOnly, skipValidation Body: {:labels {}, :alloydb {:clusterId string, :settings AlloyDbSettings}, :postgresql {:ssl SslConfig, :password string, :networkArchitecture string, :privateServiceConnectConnectivity PrivateServiceConnectConnectivity, :username string, :staticIpConnectivity StaticIpConnectivity, :cloudSqlId string, :port integer, :host string, :alloydbClusterId string, :passwordSet boolean}, :displayName string, :name string, :createTime string, :cloudsql {:cloudSqlId string, :settings CloudSqlSettings, :privateIp string, :publicIp string, :additionalPublicIp string}, :oracle {:ssl SslConfig, :privateConnectivity PrivateConnectivity, :password string, :username string, :forwardSshConnectivity ForwardSshTunnelConnectivity, :port integer, :host string, :databaseService string, :staticServiceIpConnectivity StaticServiceIpConnectivity, :passwordSet boolean}, :state string, :updateTime string, :error {:code integer, :message string, :details [{}]}, :provider string, :mysql {:host string, :port integer, :username string, :password string, :passwordSet boolean, :ssl SslConfig, :cloudSqlId string}, :sqlserver {:ssl SslConfig, :privateConnectivity PrivateConnectivity, :password string, :privateServiceConnectConnectivity PrivateServiceConnectConnectivity, :username string, :staticIpConnectivity StaticIpConnectivity, :forwardSshConnectivity ForwardSshTunnelConnectivity, :cloudSqlId string, :port integer, :backups SqlServerBackups, :host string, :passwordSet boolean}} Creates a new connection profile in a given project and location.
(locations-connectionProfiles-delete$ auth parameters)
Required parameters: name
Optional parameters: requestId, force
Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/connectionProfiles/delete Required parameters: name Optional parameters: requestId, force Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.
(locations-connectionProfiles-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets details of a single connection profile.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/connectionProfiles/get Required parameters: name Optional parameters: none Gets details of a single connection profile.
(locations-connectionProfiles-getIamPolicy$ auth parameters)
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/connectionProfiles/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(locations-connectionProfiles-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken, filter, orderBy
Retrieves a list of all connection profiles in a given project and location.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/connectionProfiles/list Required parameters: parent Optional parameters: pageSize, pageToken, filter, orderBy Retrieves a list of all connection profiles in a given project and location.
(locations-connectionProfiles-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask, requestId, validateOnly, skipValidation
Body:
{:labels {}, :alloydb {:clusterId string, :settings AlloyDbSettings}, :postgresql {:ssl SslConfig, :password string, :networkArchitecture string, :privateServiceConnectConnectivity PrivateServiceConnectConnectivity, :username string, :staticIpConnectivity StaticIpConnectivity, :cloudSqlId string, :port integer, :host string, :alloydbClusterId string, :passwordSet boolean}, :displayName string, :name string, :createTime string, :cloudsql {:cloudSqlId string, :settings CloudSqlSettings, :privateIp string, :publicIp string, :additionalPublicIp string}, :oracle {:ssl SslConfig, :privateConnectivity PrivateConnectivity, :password string, :username string, :forwardSshConnectivity ForwardSshTunnelConnectivity, :port integer, :host string, :databaseService string, :staticServiceIpConnectivity StaticServiceIpConnectivity, :passwordSet boolean}, :state string, :updateTime string, :error {:code integer, :message string, :details [{}]}, :provider string, :mysql {:host string, :port integer, :username string, :password string, :passwordSet boolean, :ssl SslConfig, :cloudSqlId string}, :sqlserver {:ssl SslConfig, :privateConnectivity PrivateConnectivity, :password string, :privateServiceConnectConnectivity PrivateServiceConnectConnectivity, :username string, :staticIpConnectivity StaticIpConnectivity, :forwardSshConnectivity ForwardSshTunnelConnectivity, :cloudSqlId string, :port integer, :backups SqlServerBackups, :host string, :passwordSet boolean}}
Update the configuration of a single connection profile.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/connectionProfiles/patch Required parameters: name Optional parameters: updateMask, requestId, validateOnly, skipValidation Body: {:labels {}, :alloydb {:clusterId string, :settings AlloyDbSettings}, :postgresql {:ssl SslConfig, :password string, :networkArchitecture string, :privateServiceConnectConnectivity PrivateServiceConnectConnectivity, :username string, :staticIpConnectivity StaticIpConnectivity, :cloudSqlId string, :port integer, :host string, :alloydbClusterId string, :passwordSet boolean}, :displayName string, :name string, :createTime string, :cloudsql {:cloudSqlId string, :settings CloudSqlSettings, :privateIp string, :publicIp string, :additionalPublicIp string}, :oracle {:ssl SslConfig, :privateConnectivity PrivateConnectivity, :password string, :username string, :forwardSshConnectivity ForwardSshTunnelConnectivity, :port integer, :host string, :databaseService string, :staticServiceIpConnectivity StaticServiceIpConnectivity, :passwordSet boolean}, :state string, :updateTime string, :error {:code integer, :message string, :details [{}]}, :provider string, :mysql {:host string, :port integer, :username string, :password string, :passwordSet boolean, :ssl SslConfig, :cloudSqlId string}, :sqlserver {:ssl SslConfig, :privateConnectivity PrivateConnectivity, :password string, :privateServiceConnectConnectivity PrivateServiceConnectConnectivity, :username string, :staticIpConnectivity StaticIpConnectivity, :forwardSshConnectivity ForwardSshTunnelConnectivity, :cloudSqlId string, :port integer, :backups SqlServerBackups, :host string, :passwordSet boolean}} Update the configuration of a single connection profile.
(locations-connectionProfiles-setIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/connectionProfiles/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(locations-connectionProfiles-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/connectionProfiles/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
(locations-conversionWorkspaces-apply$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:filter string, :dryRun boolean, :autoCommit boolean, :connectionProfile string}
Applies draft tree onto a specific destination database.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/apply Required parameters: name Optional parameters: none Body: {:filter string, :dryRun boolean, :autoCommit boolean, :connectionProfile string} Applies draft tree onto a specific destination database.
(locations-conversionWorkspaces-commit$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:commitName string}
Marks all the data in the conversion workspace as committed.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/commit Required parameters: name Optional parameters: none Body: {:commitName string} Marks all the data in the conversion workspace as committed.
(locations-conversionWorkspaces-convert$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:autoCommit boolean, :filter string, :convertFullPath boolean}
Creates a draft tree schema for the destination database.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/convert Required parameters: name Optional parameters: none Body: {:autoCommit boolean, :filter string, :convertFullPath boolean} Creates a draft tree schema for the destination database.
(locations-conversionWorkspaces-create$ auth parameters body)
Required parameters: parent
Optional parameters: conversionWorkspaceId, requestId
Body:
{:latestCommitTime string, :latestCommitId string, :displayName string, :name string, :createTime string, :hasUncommittedChanges boolean, :source {:engine string, :version string}, :updateTime string, :globalSettings {}, :destination {:engine string, :version string}}
Creates a new conversion workspace in a given project and location.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/create Required parameters: parent Optional parameters: conversionWorkspaceId, requestId Body: {:latestCommitTime string, :latestCommitId string, :displayName string, :name string, :createTime string, :hasUncommittedChanges boolean, :source {:engine string, :version string}, :updateTime string, :globalSettings {}, :destination {:engine string, :version string}} Creates a new conversion workspace in a given project and location.
(locations-conversionWorkspaces-delete$ auth parameters)
Required parameters: name
Optional parameters: requestId, force
Deletes a single conversion workspace.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/delete Required parameters: name Optional parameters: requestId, force Deletes a single conversion workspace.
(locations-conversionWorkspaces-describeConversionWorkspaceRevisions$
auth
parameters)
Required parameters: conversionWorkspace
Optional parameters: commitId
Retrieves a list of committed revisions of a specific conversion workspace.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/describeConversionWorkspaceRevisions Required parameters: conversionWorkspace Optional parameters: commitId Retrieves a list of committed revisions of a specific conversion workspace.
(locations-conversionWorkspaces-describeDatabaseEntities$ auth parameters)
Required parameters: conversionWorkspace
Optional parameters: pageSize, pageToken, tree, uncommitted, commitId, filter, view
Describes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/describeDatabaseEntities Required parameters: conversionWorkspace Optional parameters: pageSize, pageToken, tree, uncommitted, commitId, filter, view Describes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.
(locations-conversionWorkspaces-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets details of a single conversion workspace.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/get Required parameters: name Optional parameters: none Gets details of a single conversion workspace.
(locations-conversionWorkspaces-getIamPolicy$ auth parameters)
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(locations-conversionWorkspaces-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken, filter
Lists conversion workspaces in a given project and location.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/list Required parameters: parent Optional parameters: pageSize, pageToken, filter Lists conversion workspaces in a given project and location.
(locations-conversionWorkspaces-mappingRules-create$ auth parameters body)
Required parameters: parent
Optional parameters: mappingRuleId, requestId
Body:
{:setTablePrimaryKey {:primaryKeyColumns [string], :primaryKey string}, :ruleScope string, :multiColumnDataTypeChange {:sourceTextFilter SourceTextFilter, :sourceDataTypeFilter string, :customFeatures {}, :overrideLength string, :overridePrecision integer, :overrideFractionalSecondsPrecision integer, :newDataType string, :sourceNumericFilter SourceNumericFilter, :overrideScale integer}, :singleColumnChange {:customFeatures {}, :scale integer, :precision integer, :arrayLength integer, :collation string, :array boolean, :charset string, :autoGenerated boolean, :udt boolean, :dataType string, :comment string, :length string, :setValues [string], :fractionalSecondsPrecision integer, :nullable boolean}, :entityMove {:newSchema string}, :displayName string, :revisionCreateTime string, :name string, :revisionId string, :multiEntityRename {:newNamePattern string, :sourceNameTransformation string}, :state string, :filterTableColumns {:includeColumns [string], :excludeColumns [string]}, :convertRowidColumn {:onlyIfNoPrimaryKey boolean}, :conditionalColumnSetValue {:sourceTextFilter SourceTextFilter, :sourceNumericFilter SourceNumericFilter, :valueTransformation ValueTransformation, :customFeatures {}}, :filter {:parentEntity string, :entityNamePrefix string, :entityNameSuffix string, :entityNameContains string, :entities [string]}, :singlePackageChange {:packageDescription string, :packageBody string}, :singleEntityRename {:newName string}, :ruleOrder string, :sourceSqlChange {:sqlCode string}}
Creates a new mapping rule for a given conversion workspace.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/mappingRules/create Required parameters: parent Optional parameters: mappingRuleId, requestId Body: {:setTablePrimaryKey {:primaryKeyColumns [string], :primaryKey string}, :ruleScope string, :multiColumnDataTypeChange {:sourceTextFilter SourceTextFilter, :sourceDataTypeFilter string, :customFeatures {}, :overrideLength string, :overridePrecision integer, :overrideFractionalSecondsPrecision integer, :newDataType string, :sourceNumericFilter SourceNumericFilter, :overrideScale integer}, :singleColumnChange {:customFeatures {}, :scale integer, :precision integer, :arrayLength integer, :collation string, :array boolean, :charset string, :autoGenerated boolean, :udt boolean, :dataType string, :comment string, :length string, :setValues [string], :fractionalSecondsPrecision integer, :nullable boolean}, :entityMove {:newSchema string}, :displayName string, :revisionCreateTime string, :name string, :revisionId string, :multiEntityRename {:newNamePattern string, :sourceNameTransformation string}, :state string, :filterTableColumns {:includeColumns [string], :excludeColumns [string]}, :convertRowidColumn {:onlyIfNoPrimaryKey boolean}, :conditionalColumnSetValue {:sourceTextFilter SourceTextFilter, :sourceNumericFilter SourceNumericFilter, :valueTransformation ValueTransformation, :customFeatures {}}, :filter {:parentEntity string, :entityNamePrefix string, :entityNameSuffix string, :entityNameContains string, :entities [string]}, :singlePackageChange {:packageDescription string, :packageBody string}, :singleEntityRename {:newName string}, :ruleOrder string, :sourceSqlChange {:sqlCode string}} Creates a new mapping rule for a given conversion workspace.
(locations-conversionWorkspaces-mappingRules-delete$ auth parameters)
Required parameters: name
Optional parameters: requestId
Deletes a single mapping rule.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/mappingRules/delete Required parameters: name Optional parameters: requestId Deletes a single mapping rule.
(locations-conversionWorkspaces-mappingRules-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets the details of a mapping rule.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/mappingRules/get Required parameters: name Optional parameters: none Gets the details of a mapping rule.
(locations-conversionWorkspaces-mappingRules-import$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:rulesFormat string, :rulesFiles [{:rulesSourceFilename string, :rulesContent string}], :autoCommit boolean}
Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/mappingRules/import Required parameters: parent Optional parameters: none Body: {:rulesFormat string, :rulesFiles [{:rulesSourceFilename string, :rulesContent string}], :autoCommit boolean} Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.
(locations-conversionWorkspaces-mappingRules-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Lists the mapping rules for a specific conversion workspace.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/mappingRules/list Required parameters: parent Optional parameters: pageSize, pageToken Lists the mapping rules for a specific conversion workspace.
(locations-conversionWorkspaces-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask, requestId
Body:
{:latestCommitTime string, :latestCommitId string, :displayName string, :name string, :createTime string, :hasUncommittedChanges boolean, :source {:engine string, :version string}, :updateTime string, :globalSettings {}, :destination {:engine string, :version string}}
Updates the parameters of a single conversion workspace.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/patch Required parameters: name Optional parameters: updateMask, requestId Body: {:latestCommitTime string, :latestCommitId string, :displayName string, :name string, :createTime string, :hasUncommittedChanges boolean, :source {:engine string, :version string}, :updateTime string, :globalSettings {}, :destination {:engine string, :version string}} Updates the parameters of a single conversion workspace.
(locations-conversionWorkspaces-rollback$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{}
Rolls back a conversion workspace to the last committed snapshot.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/rollback Required parameters: name Optional parameters: none Body: {} Rolls back a conversion workspace to the last committed snapshot.
(locations-conversionWorkspaces-searchBackgroundJobs$ auth parameters)
Required parameters: conversionWorkspace
Optional parameters: returnMostRecentPerJobType, maxSize, completedUntilTime
Searches/lists the background jobs for a specific conversion workspace. The background jobs are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are a way to expose the data plane jobs log.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/searchBackgroundJobs Required parameters: conversionWorkspace Optional parameters: returnMostRecentPerJobType, maxSize, completedUntilTime Searches/lists the background jobs for a specific conversion workspace. The background jobs are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are a way to expose the data plane jobs log.
(locations-conversionWorkspaces-seed$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:autoCommit boolean, :sourceConnectionProfile string, :destinationConnectionProfile string}
Imports a snapshot of the source database into the conversion workspace.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/seed Required parameters: name Optional parameters: none Body: {:autoCommit boolean, :sourceConnectionProfile string, :destinationConnectionProfile string} Imports a snapshot of the source database into the conversion workspace.
(locations-conversionWorkspaces-setIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(locations-conversionWorkspaces-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/conversionWorkspaces/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
(locations-fetchStaticIps$ auth parameters)
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/fetchStaticIps
Required parameters: name
Optional parameters: pageSize, pageToken
Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/fetchStaticIps Required parameters: name Optional parameters: pageSize, pageToken Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.
(locations-get$ auth parameters)
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/get
Required parameters: name
Optional parameters: none
Gets information about a location.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/get Required parameters: name Optional parameters: none Gets information about a location.
(locations-list$ auth parameters)
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/list
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists information about the supported locations for this service.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists information about the supported locations for this service.
(locations-migrationJobs-create$ auth parameters body)
Required parameters: parent
Optional parameters: migrationJobId, requestId
Body:
{:labels {}, :reverseSshConnectivity {:vmIp string, :vmPort integer, :vm string, :vpc string}, :destinationDatabase {:provider string, :engine string}, :dumpPath string, :displayName string, :name string, :endTime string, :createTime string, :phase string, :type string, :staticIpConnectivity {}, :duration string, :state string, :source string, :performanceConfig {:dumpParallelLevel string}, :dumpFlags {:dumpFlags [DumpFlag]}, :updateTime string, :filter string, :sqlserverHomogeneousMigrationJobConfig {:backupFilePattern string, :databaseBackups [SqlServerDatabaseBackup]}, :error {:code integer, :message string, :details [{}]}, :sourceDatabase {:provider string, :engine string}, :cmekKeyName string, :vpcPeeringConnectivity {:vpc string}, :destination string, :conversionWorkspace {:name string, :commitId string}}
Creates a new migration job in a given project and location.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/create Required parameters: parent Optional parameters: migrationJobId, requestId Body: {:labels {}, :reverseSshConnectivity {:vmIp string, :vmPort integer, :vm string, :vpc string}, :destinationDatabase {:provider string, :engine string}, :dumpPath string, :displayName string, :name string, :endTime string, :createTime string, :phase string, :type string, :staticIpConnectivity {}, :duration string, :state string, :source string, :performanceConfig {:dumpParallelLevel string}, :dumpFlags {:dumpFlags [DumpFlag]}, :updateTime string, :filter string, :sqlserverHomogeneousMigrationJobConfig {:backupFilePattern string, :databaseBackups [SqlServerDatabaseBackup]}, :error {:code integer, :message string, :details [{}]}, :sourceDatabase {:provider string, :engine string}, :cmekKeyName string, :vpcPeeringConnectivity {:vpc string}, :destination string, :conversionWorkspace {:name string, :commitId string}} Creates a new migration job in a given project and location.
(locations-migrationJobs-delete$ auth parameters)
Required parameters: name
Optional parameters: requestId, force
Deletes a single migration job.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/delete Required parameters: name Optional parameters: requestId, force Deletes a single migration job.
(locations-migrationJobs-demoteDestination$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{}
Demotes the destination database to become a read replica of the source. This is applicable for the following migrations: 1. MySQL to Cloud SQL for MySQL 2. PostgreSQL to Cloud SQL for PostgreSQL 3. PostgreSQL to AlloyDB for PostgreSQL.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/demoteDestination Required parameters: name Optional parameters: none Body: {} Demotes the destination database to become a read replica of the source. This is applicable for the following migrations: 1. MySQL to Cloud SQL for MySQL 2. PostgreSQL to Cloud SQL for PostgreSQL 3. PostgreSQL to AlloyDB for PostgreSQL.
(locations-migrationJobs-generateSshScript$ auth parameters body)
Required parameters: migrationJob
Optional parameters: none
Body:
{:vm string, :vmCreationConfig {:vmMachineType string, :vmZone string, :subnet string}, :vmSelectionConfig {:vmZone string}, :vmPort integer}
Generate a SSH configuration script to configure the reverse SSH connectivity.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/generateSshScript Required parameters: migrationJob Optional parameters: none Body: {:vm string, :vmCreationConfig {:vmMachineType string, :vmZone string, :subnet string}, :vmSelectionConfig {:vmZone string}, :vmPort integer} Generate a SSH configuration script to configure the reverse SSH connectivity.
(locations-migrationJobs-generateTcpProxyScript$ auth parameters body)
Required parameters: migrationJob
Optional parameters: none
Body:
{:vmName string, :vmMachineType string, :vmZone string, :vmSubnet string}
Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/generateTcpProxyScript Required parameters: migrationJob Optional parameters: none Body: {:vmName string, :vmMachineType string, :vmZone string, :vmSubnet string} Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.
(locations-migrationJobs-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets details of a single migration job.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/get Required parameters: name Optional parameters: none Gets details of a single migration job.
(locations-migrationJobs-getIamPolicy$ auth parameters)
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(locations-migrationJobs-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken, filter, orderBy
Lists migration jobs in a given project and location.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/list Required parameters: parent Optional parameters: pageSize, pageToken, filter, orderBy Lists migration jobs in a given project and location.
(locations-migrationJobs-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask, requestId
Body:
{:labels {}, :reverseSshConnectivity {:vmIp string, :vmPort integer, :vm string, :vpc string}, :destinationDatabase {:provider string, :engine string}, :dumpPath string, :displayName string, :name string, :endTime string, :createTime string, :phase string, :type string, :staticIpConnectivity {}, :duration string, :state string, :source string, :performanceConfig {:dumpParallelLevel string}, :dumpFlags {:dumpFlags [DumpFlag]}, :updateTime string, :filter string, :sqlserverHomogeneousMigrationJobConfig {:backupFilePattern string, :databaseBackups [SqlServerDatabaseBackup]}, :error {:code integer, :message string, :details [{}]}, :sourceDatabase {:provider string, :engine string}, :cmekKeyName string, :vpcPeeringConnectivity {:vpc string}, :destination string, :conversionWorkspace {:name string, :commitId string}}
Updates the parameters of a single migration job.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/patch Required parameters: name Optional parameters: updateMask, requestId Body: {:labels {}, :reverseSshConnectivity {:vmIp string, :vmPort integer, :vm string, :vpc string}, :destinationDatabase {:provider string, :engine string}, :dumpPath string, :displayName string, :name string, :endTime string, :createTime string, :phase string, :type string, :staticIpConnectivity {}, :duration string, :state string, :source string, :performanceConfig {:dumpParallelLevel string}, :dumpFlags {:dumpFlags [DumpFlag]}, :updateTime string, :filter string, :sqlserverHomogeneousMigrationJobConfig {:backupFilePattern string, :databaseBackups [SqlServerDatabaseBackup]}, :error {:code integer, :message string, :details [{}]}, :sourceDatabase {:provider string, :engine string}, :cmekKeyName string, :vpcPeeringConnectivity {:vpc string}, :destination string, :conversionWorkspace {:name string, :commitId string}} Updates the parameters of a single migration job.
(locations-migrationJobs-promote$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{}
Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/promote Required parameters: name Optional parameters: none Body: {} Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.
(locations-migrationJobs-restart$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:skipValidation boolean}
Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/restart Required parameters: name Optional parameters: none Body: {:skipValidation boolean} Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.
(locations-migrationJobs-resume$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{}
Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/resume Required parameters: name Optional parameters: none Body: {} Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).
(locations-migrationJobs-setIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(locations-migrationJobs-start$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:skipValidation boolean}
Start an already created migration job.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/start Required parameters: name Optional parameters: none Body: {:skipValidation boolean} Start an already created migration job.
(locations-migrationJobs-stop$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{}
Stops a running migration job.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/stop Required parameters: name Optional parameters: none Body: {} Stops a running migration job.
(locations-migrationJobs-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
(locations-migrationJobs-verify$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:updateMask string, :migrationJob {:labels {}, :reverseSshConnectivity ReverseSshConnectivity, :destinationDatabase DatabaseType, :dumpPath string, :displayName string, :name string, :endTime string, :createTime string, :phase string, :type string, :staticIpConnectivity StaticIpConnectivity, :duration string, :state string, :source string, :performanceConfig PerformanceConfig, :dumpFlags DumpFlags, :updateTime string, :filter string, :sqlserverHomogeneousMigrationJobConfig SqlServerHomogeneousMigrationJobConfig, :error Status, :sourceDatabase DatabaseType, :cmekKeyName string, :vpcPeeringConnectivity VpcPeeringConnectivity, :destination string, :conversionWorkspace ConversionWorkspaceInfo}}
Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/migrationJobs/verify Required parameters: name Optional parameters: none Body: {:updateMask string, :migrationJob {:labels {}, :reverseSshConnectivity ReverseSshConnectivity, :destinationDatabase DatabaseType, :dumpPath string, :displayName string, :name string, :endTime string, :createTime string, :phase string, :type string, :staticIpConnectivity StaticIpConnectivity, :duration string, :state string, :source string, :performanceConfig PerformanceConfig, :dumpFlags DumpFlags, :updateTime string, :filter string, :sqlserverHomogeneousMigrationJobConfig SqlServerHomogeneousMigrationJobConfig, :error Status, :sourceDatabase DatabaseType, :cmekKeyName string, :vpcPeeringConnectivity VpcPeeringConnectivity, :destination string, :conversionWorkspace ConversionWorkspaceInfo}} Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.
(locations-operations-cancel$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{}
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/operations/cancel Required parameters: name Optional parameters: none Body: {} Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
(locations-operations-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/operations/delete Required parameters: name Optional parameters: none Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
(locations-operations-get$ auth parameters)
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/operations/get
Required parameters: name
Optional parameters: none
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/operations/get Required parameters: name Optional parameters: none Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
(locations-operations-list$ auth parameters)
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/operations/list
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-privateConnections-create$ auth parameters body)
Required parameters: parent
Optional parameters: privateConnectionId, requestId, skipValidation
Body:
{:name string, :createTime string, :updateTime string, :labels {}, :displayName string, :state string, :error {:code integer, :message string, :details [{}]}, :vpcPeeringConfig {:vpcName string, :subnet string}}
Creates a new private connection in a given project and location.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/privateConnections/create Required parameters: parent Optional parameters: privateConnectionId, requestId, skipValidation Body: {:name string, :createTime string, :updateTime string, :labels {}, :displayName string, :state string, :error {:code integer, :message string, :details [{}]}, :vpcPeeringConfig {:vpcName string, :subnet string}} Creates a new private connection in a given project and location.
(locations-privateConnections-delete$ auth parameters)
Required parameters: name
Optional parameters: requestId
Deletes a single Database Migration Service private connection.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/privateConnections/delete Required parameters: name Optional parameters: requestId Deletes a single Database Migration Service private connection.
(locations-privateConnections-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets details of a single private connection.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/privateConnections/get Required parameters: name Optional parameters: none Gets details of a single private connection.
(locations-privateConnections-getIamPolicy$ auth parameters)
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/privateConnections/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(locations-privateConnections-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken, filter, orderBy
Retrieves a list of private connections in a given project and location.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/privateConnections/list Required parameters: parent Optional parameters: pageSize, pageToken, filter, orderBy Retrieves a list of private connections in a given project and location.
(locations-privateConnections-setIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/privateConnections/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(locations-privateConnections-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
https://cloud.google.com/database-migration/api/reference/rest/v1/projects/locations/privateConnections/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close