datamigration/v1 library
Database Migration API - v1
Manage Cloud Database Migration Service resources on Google Cloud Platform.
For more information, see cloud.google.com/database-migration/
Create an instance of DatabaseMigrationServiceApi to access these resources:
Classes
- AlloyDbConnectionProfile
- Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster.
- AlloyDbSettings
- Settings for creating an AlloyDB cluster.
- ApplyConversionWorkspaceRequest
- Request message for 'ApplyConversionWorkspace' request.
- ApplyHash
- Apply a hash function on the value.
- ApplyJobDetails
- Details regarding an Apply background job.
- AssignSpecificValue
- Set to a specific value (value is converted to fit the target data type)
- AuditConfig
- Specifies the audit configuration for a service.
- BackgroundJobLogEntry
- Execution log of a background job.
- Binding
-
Associates
members
, or principals, with arole
. - CloudSqlConnectionProfile
- Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance.
- CloudSqlSettings
- Settings for creating a Cloud SQL database instance.
- ColumnEntity
- Column is not used as an independent entity, it is retrieved as part of a Table entity.
- CommitConversionWorkspaceRequest
- Request message for 'CommitConversionWorkspace' request.
- ConditionalColumnSetValue
- Options to configure rule type ConditionalColumnSetValue.
- ConnectionProfile
- A connection profile definition.
- ConstraintEntity
- Constraint is not used as an independent entity, it is retrieved as part of another entity such as Table or View.
- ConversionWorkspace
- The main conversion workspace resource entity.
- ConversionWorkspaceInfo
- A conversion workspace's version.
- ConvertConversionWorkspaceRequest
- Request message for 'ConvertConversionWorkspace' request.
- ConvertJobDetails
- Details regarding a Convert background job.
- ConvertRowIdToColumn
- Options to configure rule type ConvertROWIDToColumn.
- DatabaseEngineInfo
- The type and version of a source or destination database.
- DatabaseEntity
- The base entity type for all the database related entities.
- DatabaseMigrationServiceApi
- Manage Cloud Database Migration Service resources on Google Cloud Platform.
- DatabaseType
- A message defining the database engine and provider.
- DataCacheConfig
- Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only.
- DescribeConversionWorkspaceRevisionsResponse
- Response message for 'DescribeConversionWorkspaceRevisions' request.
- DescribeDatabaseEntitiesResponse
- Response message for 'DescribeDatabaseEntities' request.
- DoubleComparisonFilter
- Filter based on relation between source value and compare value of type double in ConditionalColumnSetValue
- DumpFlag
- Dump flag definition.
- DumpFlags
- Dump flags definition.
- EntityDdl
- A single DDL statement for a specific entity
- EntityIssue
- Issue related to the entity.
- EntityMapping
- Details of the mappings of a database entity.
- EntityMappingLogEntry
- A single record of a rule which was used for a mapping.
- EntityMove
- Options to configure rule type EntityMove.
- FetchStaticIpsResponse
- Response message for a 'FetchStaticIps' request.
- FilterTableColumns
- Options to configure rule type FilterTableColumns.
- FunctionEntity
- Function's parent is a schema.
- GenerateSshScriptRequest
- Request message for 'GenerateSshScript' request.
- GenerateTcpProxyScriptRequest
- Request message for 'GenerateTcpProxyScript' request.
- ImportMappingRulesRequest
- Request message for 'ImportMappingRules' request.
- ImportRulesJobDetails
- Details regarding an Import Rules background job.
- IndexEntity
- Index is not used as an independent entity, it is retrieved as part of a Table entity.
- IntComparisonFilter
- Filter based on relation between source value and compare value of type integer in ConditionalColumnSetValue
- ListConnectionProfilesResponse
- Response message for 'ListConnectionProfiles' request.
- ListConversionWorkspacesResponse
- Response message for 'ListConversionWorkspaces' request.
- ListLocationsResponse
- The response message for Locations.ListLocations.
- ListMappingRulesResponse
- Response message for 'ListMappingRulesRequest' request.
- ListMigrationJobsResponse
- Response message for 'ListMigrationJobs' request.
- ListOperationsResponse
- The response message for Operations.ListOperations.
- ListPrivateConnectionsResponse
- Response message for 'ListPrivateConnections' request.
- MappingRule
- Definition of a transformation that is to be applied to a group of entities in the source schema.
- MappingRuleFilter
- A filter defining the entities that a mapping rule should be applied to.
- MaterializedViewEntity
- MaterializedView's parent is a schema.
- MigrationJob
- Represents a Database Migration Service migration job object.
- MultiColumnDatatypeChange
- Options to configure rule type MultiColumnDatatypeChange.
- MultiEntityRename
- Options to configure rule type MultiEntityRename.
- MySqlConnectionProfile
- Specifies connection parameters required specifically for MySQL databases.
- Operation
- This resource represents a long-running operation that is the result of a network API call.
- OracleConnectionProfile
- Specifies connection parameters required specifically for Oracle databases.
- PackageEntity
- Package's parent is a schema.
- PerformanceConfig
- Performance configuration definition.
- Policy
- An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
- Position
- Issue position.
- PostgreSqlConnectionProfile
- Specifies connection parameters required specifically for PostgreSQL databases.
- PrimaryInstanceSettings
- Settings for the cluster's primary instance
- PrivateConnection
- The PrivateConnection resource is used to establish private connectivity with the customer's network.
- PrivateConnectivity
- Private Connectivity.
- PrivateServiceConnectConnectivity
- Private Service Connect connectivity
- ProjectsLocationsConnectionProfilesResource
- ProjectsLocationsConversionWorkspacesMappingRulesResource
- ProjectsLocationsConversionWorkspacesResource
- ProjectsLocationsMigrationJobsResource
- ProjectsLocationsOperationsResource
- ProjectsLocationsPrivateConnectionsResource
- ProjectsLocationsResource
- ProjectsResource
- RestartMigrationJobRequest
- Request message for 'RestartMigrationJob' request.
- ResumeMigrationJobRequest
- Request message for 'ResumeMigrationJob' request.
- ReverseSshConnectivity
- The details needed to configure a reverse SSH tunnel between the source and destination databases.
- RoundToScale
- This allows the data to change scale, for example if the source is 2 digits after the decimal point, specify round to scale value = 2.
- RulesFile
- Details of a single rules file.
- SearchBackgroundJobsResponse
- Response message for 'SearchBackgroundJobs' request.
- SeedConversionWorkspaceRequest
- Request message for 'SeedConversionWorkspace' request.
- SeedJobDetails
- Details regarding a Seed background job.
- SequenceEntity
- Sequence's parent is a schema.
- SetIamPolicyRequest
-
Request message for
SetIamPolicy
method. - SetTablePrimaryKey
- Options to configure rule type SetTablePrimaryKey.
- SingleColumnChange
- Options to configure rule type SingleColumnChange.
- SingleEntityRename
- Options to configure rule type SingleEntityRename.
- SinglePackageChange
- Options to configure rule type SinglePackageChange.
- SourceNumericFilter
- Filter for fixed point number data types such as NUMERIC/NUMBER
- SourceSqlChange
- Options to configure rule type SourceSqlChange.
- SourceTextFilter
- Filter for text-based data types like varchar.
- SqlAclEntry
- An entry for an Access Control list.
- SqlIpConfig
- IP Management configuration.
- SqlServerBackups
- Specifies the backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.
- SqlServerConnectionProfile
- Specifies connection parameters required specifically for SQL Server databases.
- SqlServerDatabaseBackup
- Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.
- SqlServerEncryptionOptions
- Encryption settings for the SQL Server database.
- SqlServerHomogeneousMigrationJobConfig
- Configuration for homogeneous migration to Cloud SQL for SQL Server.
- SshScript
- Response message for 'GenerateSshScript' request.
- SslConfig
- SSL configuration information.
- StartMigrationJobRequest
- Request message for 'StartMigrationJob' request.
- StoredProcedureEntity
- Stored procedure's parent is a schema.
- SynonymEntity
- Synonym's parent is a schema.
- TableEntity
- Table's parent is a schema.
- TcpProxyScript
- Response message for 'GenerateTcpProxyScript' request.
- TriggerEntity
- Trigger is not used as an independent entity, it is retrieved as part of a Table entity.
- UDTEntity
- UDT's parent is a schema.
- UserPassword
- The username/password for a database user.
- ValueListFilter
- A list of values to filter by in ConditionalColumnSetValue
- ValueTransformation
- Description of data transformation during migration as part of the ConditionalColumnSetValue.
- VerifyMigrationJobRequest
- Request message for 'VerifyMigrationJob' request.
- ViewEntity
- View's parent is a schema.
- VmCreationConfig
- VM creation configuration message
- VmSelectionConfig
- VM selection configuration message
- VpcPeeringConfig
- The VPC peering configuration is used to create VPC peering with the consumer's VPC.
- VpcPeeringConnectivity
- The details of the VPC where the source database is located in Google Cloud.
Typedefs
- AuditLogConfig = $AuditLogConfig
- Provides the configuration for logging a type of permissions.
- CancelOperationRequest = $Empty
- The request message for Operations.CancelOperation.
- DatabaseInstanceEntity = $Entity
- DatabaseInstance acts as a parent entity to other database entities.
- DemoteDestinationRequest = $Empty
- Request message for 'DemoteDestination' request.
- Empty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- EncryptionConfig = $EncryptionConfig
- EncryptionConfig describes the encryption config of a cluster that is encrypted with a CMEK (customer-managed encryption key).
- Expr = $Expr
- Represents a textual expression in the Common Expression Language (CEL) syntax.
- ForwardSshTunnelConnectivity = $ForwardSshTunnelConnectivity
- Forward SSH Tunnel connectivity.
- Location = $Location00
- A resource that represents a Google Cloud location.
- MachineConfig = $MachineConfig
- MachineConfig describes the configuration of a machine.
- PromoteMigrationJobRequest = $Empty
- Request message for 'PromoteMigrationJob' request.
- RollbackConversionWorkspaceRequest = $Empty
- Request message for 'RollbackConversionWorkspace' request.
- SchemaEntity = $Entity
- Schema typically has no parent entity, but can have a parent entity DatabaseInstance (for database engines which support it).
- StaticIpConnectivity = $Empty
- The source database will allow incoming connections from the public IP of the destination database.
- StaticServiceIpConnectivity = $Empty
- Static IP address connectivity configured on service project.
- Status = $Status
-
The
Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. - StopMigrationJobRequest = $Empty
- Request message for 'StopMigrationJob' request.
- TestIamPermissionsRequest = $TestIamPermissionsRequest00
-
Request message for
TestIamPermissions
method. - TestIamPermissionsResponse = $PermissionsResponse
-
Response message for
TestIamPermissions
method.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.