API documentation for clouddms_v1.types package.
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BackgroundJobLogEntry
Execution log of a background job.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BackgroundJobType
The types of jobs that can be executed in the background.
Values: BACKGROUND_JOB_TYPE_UNSPECIFIED (0): Unspecified background job type. BACKGROUND_JOB_TYPE_SOURCE_SEED (1): Job to seed from the source database. BACKGROUND_JOB_TYPE_CONVERT (2): Job to convert the source database into a draft of the destination database. BACKGROUND_JOB_TYPE_APPLY_DESTINATION (3): Job to apply the draft tree onto the destination. BACKGROUND_JOB_TYPE_IMPORT_RULES_FILE (5): Job to import and convert mapping rules from an external source such as an ora2pg config file.
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.
ConnectionProfile
A connection profile definition.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
CreateConnectionProfileRequest
Request message for 'CreateConnectionProfile' request.
CreateConversionWorkspaceRequest
Request message to create a new Conversion Workspace in the specified project and region.
CreateMigrationJobRequest
Request message to create a new Database Migration Service migration job in the specified project and region.
CreatePrivateConnectionRequest
Request message to create a new private connection in the specified project and region.
DatabaseEngine
The database engine types.
Values: DATABASE_ENGINE_UNSPECIFIED (0): The source database engine of the migration job is unknown. MYSQL (1): The source engine is MySQL. POSTGRESQL (2): The source engine is PostgreSQL. ORACLE (4): The source engine is Oracle.
DatabaseEngineInfo
The type and version of a source or destination database.
DatabaseEntity
The base entity type for all the database related entities. The message contains the entity name, the name of its parent, the entity type, and the specific details per entity type.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DatabaseEntityType
The type of database entities supported,
Values: DATABASE_ENTITY_TYPE_UNSPECIFIED (0): Unspecified database entity type. DATABASE_ENTITY_TYPE_SCHEMA (1): Schema. DATABASE_ENTITY_TYPE_TABLE (2): Table. DATABASE_ENTITY_TYPE_COLUMN (3): Column. DATABASE_ENTITY_TYPE_CONSTRAINT (4): Constraint. DATABASE_ENTITY_TYPE_INDEX (5): Index. DATABASE_ENTITY_TYPE_TRIGGER (6): Trigger. DATABASE_ENTITY_TYPE_VIEW (7): View. DATABASE_ENTITY_TYPE_SEQUENCE (8): Sequence. DATABASE_ENTITY_TYPE_STORED_PROCEDURE (9): Stored Procedure. DATABASE_ENTITY_TYPE_FUNCTION (10): Function. DATABASE_ENTITY_TYPE_SYNONYM (11): Synonym. DATABASE_ENTITY_TYPE_DATABASE_PACKAGE (12): Package. DATABASE_ENTITY_TYPE_UDT (13): UDT. DATABASE_ENTITY_TYPE_MATERIALIZED_VIEW (14): Materialized View. DATABASE_ENTITY_TYPE_DATABASE (15): Database.
DatabaseProvider
The database providers.
Values: DATABASE_PROVIDER_UNSPECIFIED (0): The database provider is unknown. CLOUDSQL (1): CloudSQL runs the database. RDS (2): RDS runs the database. AURORA (3): Amazon Aurora. ALLOYDB (4): AlloyDB.
DatabaseType
A message defining the database engine and provider.
DeleteConnectionProfileRequest
Request message for 'DeleteConnectionProfile' request.
DeleteConversionWorkspaceRequest
Request message for 'DeleteConversionWorkspace' request.
DeleteMigrationJobRequest
Request message for 'DeleteMigrationJob' request.
DeletePrivateConnectionRequest
Request message to delete a private connection.
DescribeConversionWorkspaceRevisionsRequest
Request message for 'DescribeConversionWorkspaceRevisions' request.
DescribeConversionWorkspaceRevisionsResponse
Response message for 'DescribeConversionWorkspaceRevisions' request.
DescribeDatabaseEntitiesRequest
Request message for 'DescribeDatabaseEntities' request.
DescribeDatabaseEntitiesResponse
Response message for 'DescribeDatabaseEntities' request.
EntityMapping
Details of the mappings of a database entity.
EntityMappingLogEntry
A single record of a rule which was used for a mapping.
FetchStaticIpsRequest
Request message for 'FetchStaticIps' request.
FetchStaticIpsResponse
Response message for a 'FetchStaticIps' request.
ForwardSshTunnelConnectivity
Forward SSH Tunnel connectivity.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FunctionEntity
Function's parent is a schema.
GenerateSshScriptRequest
Request message for 'GenerateSshScript' request.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GetConnectionProfileRequest
Request message for 'GetConnectionProfile' request.
GetConversionWorkspaceRequest
Request message for 'GetConversionWorkspace' request.
GetMigrationJobRequest
Request message for 'GetMigrationJob' request.
GetPrivateConnectionRequest
Request message to get a private connection resource.
ImportMappingRulesRequest
Request message for 'ImportMappingRules' request.
ImportRulesFileFormat
The format for the import rules file.
Values: IMPORT_RULES_FILE_FORMAT_UNSPECIFIED (0): Unspecified rules format. IMPORT_RULES_FILE_FORMAT_HARBOUR_BRIDGE_SESSION_FILE (1): HarbourBridge session file. IMPORT_RULES_FILE_FORMAT_ORATOPG_CONFIG_FILE (2): Ora2Pg configuration file.
IndexEntity
Index is not used as an independent entity, it is retrieved as part of a Table entity.
ListConnectionProfilesRequest
Request message for 'ListConnectionProfiles' request.
ListConnectionProfilesResponse
Response message for 'ListConnectionProfiles' request.
ListConversionWorkspacesRequest
Retrieve a list of all conversion workspaces in a given project and location.
ListConversionWorkspacesResponse
Response message for 'ListConversionWorkspaces' request.
ListMigrationJobsRequest
Retrieves a list of all migration jobs in a given project and location.
ListMigrationJobsResponse
Response message for 'ListMigrationJobs' request.
ListPrivateConnectionsRequest
Request message to retrieve a list of private connections in a given project and location.
ListPrivateConnectionsResponse
Response message for 'ListPrivateConnections' request.
MigrationJob
Represents a Database Migration Service migration job object.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
MigrationJobVerificationError
Error message of a verification Migration job.
MySqlConnectionProfile
Specifies connection parameters required specifically for MySQL databases.
NetworkArchitecture
Values: NETWORK_ARCHITECTURE_UNSPECIFIED (0): No description available. NETWORK_ARCHITECTURE_OLD_CSQL_PRODUCER (1): Instance is in Cloud SQL's old producer network architecture. NETWORK_ARCHITECTURE_NEW_CSQL_PRODUCER (2): Instance is in Cloud SQL's new producer network architecture.
OperationMetadata
Represents the metadata of the long-running operation.
OracleConnectionProfile
Specifies connection parameters required specifically for Oracle databases.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PackageEntity
Package's parent is a schema.
PostgreSqlConnectionProfile
Specifies connection parameters required specifically for PostgreSQL databases.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PrivateConnection
The PrivateConnection resource is used to establish private connectivity with the customer's network.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PrivateConnectivity
Private Connectivity.
PrivateServiceConnectConnectivity
Private Service Connect connectivity (https://cloud.google.com/vpc/docs/private-service-connect#service-attachments)
PromoteMigrationJobRequest
Request message for 'PromoteMigrationJob' request.
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. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC.
RollbackConversionWorkspaceRequest
Request message for 'RollbackConversionWorkspace' request.
SchemaEntity
Schema typically has no parent entity, but can have a parent entity DatabaseInstance (for database engines which support it). For some database engines, the terms schema and user can be used interchangeably when they refer to a namespace or a collection of other database entities. Can store additional information which is schema specific.
SearchBackgroundJobsRequest
Request message for 'SearchBackgroundJobs' request.
SearchBackgroundJobsResponse
Response message for 'SearchBackgroundJobs' request.
SeedConversionWorkspaceRequest
Request message for 'SeedConversionWorkspace' request.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SequenceEntity
Sequence's parent is a schema.
SqlAclEntry
An entry for an Access Control list.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SqlIpConfig
IP Management configuration.
SshScript
Response message for 'GenerateSshScript' request.
SslConfig
SSL configuration information.
StartMigrationJobRequest
Request message for 'StartMigrationJob' request.
StaticIpConnectivity
The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required.
StaticServiceIpConnectivity
Static IP address connectivity configured on service project.
StopMigrationJobRequest
Request message for 'StopMigrationJob' request.
StoredProcedureEntity
Stored procedure's parent is a schema.
SynonymEntity
Synonym's parent is a schema.
TableEntity
Table's parent is a schema.
TriggerEntity
Trigger is not used as an independent entity, it is retrieved as part of a Table entity.
UpdateConnectionProfileRequest
Request message for 'UpdateConnectionProfile' request.
UpdateConversionWorkspaceRequest
Request message for 'UpdateConversionWorkspace' request.
UpdateMigrationJobRequest
Request message for 'UpdateMigrationJob' request.
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. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC.