Types for Google Cloud Clouddms v1 API¶
- class google.cloud.clouddms_v1.types.AlloyDbConnectionProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies required connection parameters, and the parameters required to create an AlloyDB destination cluster.
- cluster_id¶
Required. The AlloyDB cluster ID that this connection profile is associated with.
- Type
- settings¶
Immutable. Metadata used to create the destination AlloyDB cluster.
- class google.cloud.clouddms_v1.types.AlloyDbSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSettings for creating an AlloyDB cluster.
- initial_user¶
Required. Input only. Initial user to setup during cluster creation. Required.
- vpc_network¶
Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: “projects/{project_number}/global/networks/{network_id}”. This is required to create a cluster.
- Type
- labels¶
Labels for the AlloyDB cluster created by DMS. An object containing a list of ‘key’, ‘value’ pairs.
- primary_instance_settings¶
- encryption_config¶
Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
- class EncryptionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEncryptionConfig describes the encryption config of a cluster that is encrypted with a CMEK (customer-managed encryption key).
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class PrimaryInstanceSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSettings for the cluster’s primary instance
- id¶
Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression “[a-z0-9-]+”.
- Type
- machine_config¶
Configuration for the machines that host the underlying database engine.
- database_flags¶
Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.
- labels¶
Labels for the AlloyDB primary instance created by DMS. An object containing a list of ‘key’, ‘value’ pairs.
- private_ip¶
Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.
- Type
- class DatabaseFlagsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class MachineConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMachineConfig describes the configuration of a machine.
- class UserPassword(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe username/password for a database user. Used for specifying initial users at cluster creation time.
- class google.cloud.clouddms_v1.types.ApplyConversionWorkspaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘ApplyConversionWorkspace’ request.
- name¶
Required. The name of the conversion workspace resource for which to apply the draft tree. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
- Type
- filter¶
Filter which entities to apply. Leaving this field empty will apply all of the entities. Supports Google AIP 160 based filtering.
- Type
- dry_run¶
Optional. Only validates the apply process, but doesn’t change the destination database. Only works for PostgreSQL destination connection profile.
- Type
- auto_commit¶
Optional. Specifies whether the conversion workspace is to be committed automatically after the apply.
- Type
- class google.cloud.clouddms_v1.types.ApplyHash(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageApply a hash function on the value.
- class google.cloud.clouddms_v1.types.AssignSpecificValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSet to a specific value (value is converted to fit the target data type)
- class google.cloud.clouddms_v1.types.BackgroundJobLogEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageExecution 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.
- job_type¶
The type of job that was executed.
- start_time¶
The timestamp when the background job was started.
- finish_time¶
The timestamp when the background job was finished.
- completion_state¶
Output only. Job completion state, i.e. the final state after the job completed.
- completion_comment¶
Output only. Job completion comment, such as how many entities were seeded, how many warnings were found during conversion, and similar information.
- Type
- request_autocommit¶
Output only. Whether the client requested the conversion workspace to be committed after a successful completion of the job.
- Type
- import_rules_job_details¶
Output only. Import rules job details.
This field is a member of oneof
job_details.
- class ApplyJobDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetails regarding an Apply background job.
- class ConvertJobDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetails regarding a Convert background job.
- class ImportRulesJobDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetails regarding an Import Rules background job.
- file_format¶
Output only. The requested file format.
- class JobCompletionState(value)[source]¶
Bases:
proto.enums.EnumFinal state after a job completes.
- Values:
- JOB_COMPLETION_STATE_UNSPECIFIED (0):
The status is not specified. This state is used when job is not yet finished.
- SUCCEEDED (1):
Success.
- FAILED (2):
Error.
- class SeedJobDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetails regarding a Seed background job.
- class google.cloud.clouddms_v1.types.BackgroundJobType(value)[source]¶
Bases:
proto.enums.EnumThe 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.
- class google.cloud.clouddms_v1.types.CloudSqlConnectionProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance.
- cloud_sql_id¶
Output only. The Cloud SQL instance ID that this connection profile is associated with.
- Type
- settings¶
Immutable. Metadata used to create the destination Cloud SQL database.
- class google.cloud.clouddms_v1.types.CloudSqlSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSettings for creating a Cloud SQL database instance.
- database_version¶
The database engine type and version.
- user_labels¶
The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of “key”: “value” pairs.
Example:
{ "name": "wrench", "mass": "18kg", "count": "3" }.
- tier¶
The tier (or machine type) for this instance, for example:
db-n1-standard-1(MySQL instances) ordb-custom-1-3840(PostgreSQL instances). For more information, see Cloud SQL Instance Settings.- Type
- storage_auto_resize_limit¶
The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
- activation_policy¶
The activation policy specifies when the instance is activated; it is applicable only when the instance state is ‘RUNNABLE’. Valid values:
‘ALWAYS’: The instance is on, and remains so even in the absence of connection requests.
NEVER: The instance is off; it is not activated, even if a connection request arrives.
- ip_config¶
The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.
- auto_storage_increase¶
[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.
- database_flags¶
The database flags passed to the Cloud SQL instance at startup. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.
- data_disk_type¶
The type of storage:
PD_SSD(default) orPD_HDD.
- data_disk_size_gb¶
The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.
- secondary_zone¶
Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).
- Type
- source_id¶
The Database Migration Service source connection profile ID, in the format:
projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID- Type
- root_password_set¶
Output only. Indicates If this connection profile root password is stored.
- Type
- availability_type¶
Optional. Availability type. Potential values:
ZONAL: The instance serves data from only one zone. Outages in that zone affect data availability.REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).
- edition¶
Optional. The edition of the given Cloud SQL instance.
- class DatabaseFlagsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class Edition(value)[source]¶
Bases:
proto.enums.EnumThe edition of the given Cloud SQL instance. Can be ENTERPRISE or ENTERPRISE_PLUS.
- Values:
- EDITION_UNSPECIFIED (0):
The instance did not specify the edition.
- ENTERPRISE (2):
The instance is an enterprise edition.
- ENTERPRISE_PLUS (3):
The instance is an enterprise plus edition.
- class SqlActivationPolicy(value)[source]¶
Bases:
proto.enums.EnumSpecifies when the instance should be activated.
- Values:
- SQL_ACTIVATION_POLICY_UNSPECIFIED (0):
unspecified policy.
- ALWAYS (1):
The instance is always up and running.
- NEVER (2):
The instance should never spin up.
- class SqlAvailabilityType(value)[source]¶
Bases:
proto.enums.EnumThe availability type of the given Cloud SQL instance.
- Values:
- SQL_AVAILABILITY_TYPE_UNSPECIFIED (0):
This is an unknown Availability type.
- ZONAL (1):
Zonal availablility instance.
- REGIONAL (2):
Regional availability instance.
- class SqlDataDiskType(value)[source]¶
Bases:
proto.enums.EnumThe storage options for Cloud SQL databases.
- Values:
- SQL_DATA_DISK_TYPE_UNSPECIFIED (0):
Unspecified.
- PD_SSD (1):
SSD disk.
- PD_HDD (2):
HDD disk.
- class SqlDatabaseVersion(value)[source]¶
Bases:
proto.enums.EnumThe database engine type and version.
- Values:
- SQL_DATABASE_VERSION_UNSPECIFIED (0):
Unspecified version.
- MYSQL_5_6 (1):
MySQL 5.6.
- MYSQL_5_7 (2):
MySQL 5.7.
- POSTGRES_9_6 (3):
PostgreSQL 9.6.
- POSTGRES_11 (4):
PostgreSQL 11.
- POSTGRES_10 (5):
PostgreSQL 10.
- MYSQL_8_0 (6):
MySQL 8.0.
- POSTGRES_12 (7):
PostgreSQL 12.
- POSTGRES_13 (8):
PostgreSQL 13.
- POSTGRES_14 (17):
PostgreSQL 14.
- POSTGRES_15 (18):
PostgreSQL 15.
- class UserLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.clouddms_v1.types.ColumnEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageColumn is not used as an independent entity, it is retrieved as part of a Table entity.
- fractional_seconds_precision¶
Column fractional second precision - used for timestamp based datatypes.
- Type
- custom_features¶
Custom engine specific features.
- class google.cloud.clouddms_v1.types.CommitConversionWorkspaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘CommitConversionWorkspace’ request.
- class google.cloud.clouddms_v1.types.ConditionalColumnSetValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated.
The rule filter field can refer to one or more entities.
The rule scope can be one of: Column.
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.
- source_text_filter¶
Optional. Optional filter on source column length. Used for text based data types like varchar.
This field is a member of oneof
source_filter.
- source_numeric_filter¶
Optional. Optional filter on source column precision and scale. Used for fixed point numbers such as NUMERIC/NUMBER data types.
This field is a member of oneof
source_filter.
- value_transformation¶
Required. Description of data transformation during migration.
- custom_features¶
Optional. Custom engine specific features.
- class google.cloud.clouddms_v1.types.ConnectionProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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.
- name¶
The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
- Type
- create_time¶
Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.
- update_time¶
Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.
- labels¶
The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of “key”: “value” pairs.
Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }.
- state¶
The current connection profile state (e.g. DRAFT, READY, or FAILED).
- postgresql¶
A PostgreSQL database connection profile.
This field is a member of oneof
connection_profile.
- cloudsql¶
A CloudSQL database connection profile.
This field is a member of oneof
connection_profile.
- error¶
Output only. The error details in case of state FAILED.
- Type
google.rpc.status_pb2.Status
- provider¶
The database provider.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class State(value)[source]¶
Bases:
proto.enums.EnumThe current connection profile state (e.g. DRAFT, READY, or FAILED).
- Values:
- STATE_UNSPECIFIED (0):
The state of the connection profile is unknown.
- DRAFT (1):
The connection profile is in draft mode and fully editable.
- CREATING (2):
The connection profile is being created.
- READY (3):
The connection profile is ready.
- UPDATING (4):
The connection profile is being updated.
- DELETING (5):
The connection profile is being deleted.
- DELETED (6):
The connection profile has been deleted.
- FAILED (7):
The last action on the connection profile failed.
- class google.cloud.clouddms_v1.types.ConstraintEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConstraint is not used as an independent entity, it is retrieved as part of another entity such as Table or View.
- type_¶
Type of constraint, for example unique, primary key, foreign key (currently only primary key is supported).
- Type
- table_columns¶
Table columns used as part of the Constraint, for example primary key constraint should list the columns which constitutes the key.
- Type
MutableSequence[str]
- custom_features¶
Custom engine specific features.
- reference_columns¶
Reference columns which may be associated with the constraint. For example, if the constraint is a FOREIGN_KEY, this represents the list of full names of referenced columns by the foreign key.
- Type
MutableSequence[str]
- reference_table¶
Reference table which may be associated with the constraint. For example, if the constraint is a FOREIGN_KEY, this represents the list of full name of the referenced table by the foreign key.
- Type
- class google.cloud.clouddms_v1.types.ConversionWorkspace(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe main conversion workspace resource entity.
- name¶
Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
- Type
- source¶
Required. The source engine details.
- destination¶
Required. The destination engine details.
- global_settings¶
Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true
- has_uncommitted_changes¶
Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed).
- Type
- latest_commit_time¶
Output only. The timestamp when the workspace was committed.
- create_time¶
Output only. The timestamp when the workspace resource was created.
- update_time¶
Output only. The timestamp when the workspace resource was last updated.
- class GlobalSettingsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.clouddms_v1.types.ConversionWorkspaceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA conversion workspace’s version.
- class google.cloud.clouddms_v1.types.ConvertConversionWorkspaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘ConvertConversionWorkspace’ request.
- name¶
Name of the conversion workspace resource to convert in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
- Type
- auto_commit¶
Optional. Specifies whether the conversion workspace is to be committed automatically after the conversion.
- Type
- filter¶
Optional. Filter the entities to convert. Leaving this field empty will convert all of the entities. Supports Google AIP-160 style filtering.
- Type
- class google.cloud.clouddms_v1.types.ConvertRowIdToColumn(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions to configure rule type ConvertROWIDToColumn. The rule is used to add column rowid to destination tables based on an Oracle rowid function/property.
The rule filter field can refer to one or more entities.
The rule scope can be one of: Table.
This rule requires additional filter to be specified beyond the basic rule filter field, which is whether or not to work on tables which already have a primary key defined.
- class google.cloud.clouddms_v1.types.CreateConnectionProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘CreateConnectionProfile’ request.
- connection_profile¶
Required. The create request body including the connection profile data
- request_id¶
Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.
It is recommended to always set this value to a UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- Type
- validate_only¶
Optional. Only validate the connection profile, but don’t create any resources. The default is false. Only supported for Oracle connection profiles.
- Type
- class google.cloud.clouddms_v1.types.CreateConversionWorkspaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to create a new Conversion Workspace in the specified project and region.
- conversion_workspace¶
Required. Represents a conversion workspace object.
- request_id¶
A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.
It is recommended to always set this value to a UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- Type
- class google.cloud.clouddms_v1.types.CreateMappingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘CreateMappingRule’ command.
- mapping_rule¶
Required. Represents a [mapping rule] (https://cloud.google.com/database-migration/reference/rest/v1/projects.locations.mappingRules) object.
- request_id¶
A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.
It is recommended to always set this value to a UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- Type
- class google.cloud.clouddms_v1.types.CreateMigrationJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to create a new Database Migration Service migration job in the specified project and region.
- migration_job¶
Required. Represents a migration job object.
- request_id¶
Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.
It is recommended to always set this value to a UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- Type
- class google.cloud.clouddms_v1.types.CreatePrivateConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to create a new private connection in the specified project and region.
- private_connection¶
Required. The private connection resource to create.
- request_id¶
Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.
It is recommended to always set this value to a UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- Type
- class google.cloud.clouddms_v1.types.DatabaseEngine(value)[source]¶
Bases:
proto.enums.EnumThe 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.
- class google.cloud.clouddms_v1.types.DatabaseEngineInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe type and version of a source or destination database.
- engine¶
Required. Engine type.
- class google.cloud.clouddms_v1.types.DatabaseEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe 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.
- tree¶
The type of tree the entity belongs to.
- entity_type¶
The type of the database entity (table, view, index, …).
- mappings¶
Details about entity mappings. For source tree entities, this holds the draft entities which were generated by the mapping rules. For draft tree entities, this holds the source entities which were converted to form the draft entity. Destination entities will have no mapping details.
- Type
MutableSequence[google.cloud.clouddms_v1.types.EntityMapping]
- entity_ddl¶
Details about the entity DDL script. Multiple DDL scripts are provided for child entities such as a table entity will have one DDL for the table with additional DDLs for each index, constraint and such.
- Type
MutableSequence[google.cloud.clouddms_v1.types.EntityDdl]
- issues¶
Details about the various issues found for the entity.
- Type
MutableSequence[google.cloud.clouddms_v1.types.EntityIssue]
- class TreeType(value)[source]¶
Bases:
proto.enums.EnumThe type of database entities tree.
- Values:
- TREE_TYPE_UNSPECIFIED (0):
Tree type unspecified.
- SOURCE (1):
Tree of entities loaded from a source database.
- DRAFT (2):
Tree of entities converted from the source tree using the mapping rules.
- DESTINATION (3):
Tree of entities observed on the destination database.
- class google.cloud.clouddms_v1.types.DatabaseEntityType(value)[source]¶
Bases:
proto.enums.EnumThe 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.
- class google.cloud.clouddms_v1.types.DatabaseEntityView(value)[source]¶
Bases:
proto.enums.EnumAIP-157 Partial Response view for Database Entity.
- Values:
- DATABASE_ENTITY_VIEW_UNSPECIFIED (0):
Unspecified view. Defaults to basic view.
- DATABASE_ENTITY_VIEW_BASIC (1):
Default view. Does not return DDLs or Issues.
- DATABASE_ENTITY_VIEW_FULL (2):
Return full entity details including mappings, ddl and issues.
- DATABASE_ENTITY_VIEW_ROOT_SUMMARY (3):
Top-most (Database, Schema) nodes which are returned contains summary details for their decendents such as the number of entities per type and issues rollups. When this view is used, only a single page of result is returned and the page_size property of the request is ignored. The returned page will only include the top-most node types.
- class google.cloud.clouddms_v1.types.DatabaseInstanceEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDatabaseInstance acts as a parent entity to other database entities.
- custom_features¶
Custom engine specific features.
- class google.cloud.clouddms_v1.types.DatabaseProvider(value)[source]¶
Bases:
proto.enums.EnumThe 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.
- class google.cloud.clouddms_v1.types.DatabaseType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA message defining the database engine and provider.
- provider¶
The database provider.
- engine¶
The database engine.
- class google.cloud.clouddms_v1.types.DeleteConnectionProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘DeleteConnectionProfile’ request.
- request_id¶
A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.
It is recommended to always set this value to a UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- Type
- class google.cloud.clouddms_v1.types.DeleteConversionWorkspaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘DeleteConversionWorkspace’ request.
- request_id¶
A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.
It is recommended to always set this value to a UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- Type
- class google.cloud.clouddms_v1.types.DeleteMappingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘DeleteMappingRule’ request.
- request_id¶
Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.
It is recommended to always set this value to a UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- Type
- class google.cloud.clouddms_v1.types.DeleteMigrationJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘DeleteMigrationJob’ request.
- request_id¶
A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.
It is recommended to always set this value to a UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- Type
- class google.cloud.clouddms_v1.types.DeletePrivateConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to delete a private connection.
- request_id¶
Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.
It is recommended to always set this value to a UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- Type
- class google.cloud.clouddms_v1.types.DescribeConversionWorkspaceRevisionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘DescribeConversionWorkspaceRevisions’ request.
- conversion_workspace¶
Required. Name of the conversion workspace resource whose revisions are listed. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
- Type
- class google.cloud.clouddms_v1.types.DescribeConversionWorkspaceRevisionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘DescribeConversionWorkspaceRevisions’ request.
- revisions¶
The list of conversion workspace revisions.
- Type
MutableSequence[google.cloud.clouddms_v1.types.ConversionWorkspace]
- class google.cloud.clouddms_v1.types.DescribeDatabaseEntitiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘DescribeDatabaseEntities’ request.
- conversion_workspace¶
Required. Name of the conversion workspace resource whose database entities are described. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
- Type
- page_size¶
Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.
- Type
- page_token¶
Optional. The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.
- Type
- tree¶
Required. The tree to fetch.
- uncommitted¶
Optional. 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.
- Type
- commit_id¶
Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.
- Type
- view¶
Optional. Results view based on AIP-157
- class DBTreeType(value)[source]¶
Bases:
proto.enums.EnumThe type of a tree to return
- Values:
- DB_TREE_TYPE_UNSPECIFIED (0):
Unspecified tree type.
- SOURCE_TREE (1):
The source database tree.
- DRAFT_TREE (2):
The draft database tree.
- DESTINATION_TREE (3):
The destination database tree.
- class google.cloud.clouddms_v1.types.DescribeDatabaseEntitiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘DescribeDatabaseEntities’ request.
- database_entities¶
The list of database entities for the conversion workspace.
- Type
MutableSequence[google.cloud.clouddms_v1.types.DatabaseEntity]
- class google.cloud.clouddms_v1.types.DoubleComparisonFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFilter based on relation between source value and compare value of type double in ConditionalColumnSetValue
- value_comparison¶
Required. Relation between source value and compare value
- class google.cloud.clouddms_v1.types.EntityDdl(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA single DDL statement for a specific entity
- entity_type¶
The entity type (if the DDL is for a sub entity).
- class google.cloud.clouddms_v1.types.EntityIssue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIssue related to the entity.
- type_¶
The type of the issue.
- severity¶
Severity of the issue
- entity_type¶
The entity type (if the DDL is for a sub entity).
- class IssueSeverity(value)[source]¶
Bases:
proto.enums.EnumSeverity of issue.
- Values:
- ISSUE_SEVERITY_UNSPECIFIED (0):
Unspecified issue severity
- ISSUE_SEVERITY_INFO (1):
Info
- ISSUE_SEVERITY_WARNING (2):
Warning
- ISSUE_SEVERITY_ERROR (3):
Error
- class IssueType(value)[source]¶
Bases:
proto.enums.EnumType of issue.
- Values:
- ISSUE_TYPE_UNSPECIFIED (0):
Unspecified issue type.
- ISSUE_TYPE_DDL (1):
Issue originated from the DDL
- ISSUE_TYPE_APPLY (2):
Issue originated during the apply process
- ISSUE_TYPE_CONVERT (3):
Issue originated during the convert process
- class google.cloud.clouddms_v1.types.EntityMapping(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetails of the mappings of a database entity.
- source_entity¶
Source entity full name. The source entity can also be a column, index or constraint using the same naming notation schema.table.column.
- Type
- draft_entity¶
Target entity full name. The draft entity can also include a column, index or constraint using the same naming notation schema.table.column.
- Type
- source_type¶
Type of source entity.
- draft_type¶
Type of draft entity.
- mapping_log¶
Entity mapping log entries. Multiple rules can be effective and contribute changes to a converted entity, such as a rule can handle the entity name, another rule can handle an entity type. In addition, rules which did not change the entity are also logged along with the reason preventing them to do so.
- Type
MutableSequence[google.cloud.clouddms_v1.types.EntityMappingLogEntry]
- class google.cloud.clouddms_v1.types.EntityMappingLogEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA single record of a rule which was used for a mapping.
- class google.cloud.clouddms_v1.types.EntityMove(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions to configure rule type EntityMove. The rule is used to move an entity to a new schema.
The rule filter field can refer to one or more entities.
The rule scope can be one of: Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT
- class google.cloud.clouddms_v1.types.EntityNameTransformation(value)[source]¶
Bases:
proto.enums.EnumEntity Name Transformation Types
- Values:
- ENTITY_NAME_TRANSFORMATION_UNSPECIFIED (0):
Entity name transformation unspecified.
- ENTITY_NAME_TRANSFORMATION_NO_TRANSFORMATION (1):
No transformation.
- ENTITY_NAME_TRANSFORMATION_LOWER_CASE (2):
Transform to lower case.
- ENTITY_NAME_TRANSFORMATION_UPPER_CASE (3):
Transform to upper case.
- ENTITY_NAME_TRANSFORMATION_CAPITALIZED_CASE (4):
Transform to capitalized case.
- class google.cloud.clouddms_v1.types.FetchStaticIpsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘FetchStaticIps’ request.
- name¶
Required. The resource name for the location for which static IPs should be returned. Must be in the format
projects/*/locations/*.- Type
- class google.cloud.clouddms_v1.types.FetchStaticIpsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for a ‘FetchStaticIps’ request.
- class google.cloud.clouddms_v1.types.FilterTableColumns(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table.
The rule filter field can refer to one entity.
The rule scope can be: Table
Only one of the two lists can be specified for the rule.
- class google.cloud.clouddms_v1.types.ForwardSshTunnelConnectivity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageForward 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.
- class google.cloud.clouddms_v1.types.FunctionEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFunction’s parent is a schema.
- custom_features¶
Custom engine specific features.
- class google.cloud.clouddms_v1.types.GenerateSshScriptRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest 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.
- class google.cloud.clouddms_v1.types.GenerateTcpProxyScriptRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GenerateTcpProxyScript’ request.
- vm_zone¶
Optional. The Google Cloud Platform zone to create the VM in. The fully qualified name of the zone must be specified, including the region name, for example “us-central1-b”. If not specified, uses the “-b” zone of the destination Connection Profile’s region.
- Type
- class google.cloud.clouddms_v1.types.GetConnectionProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GetConnectionProfile’ request.
- class google.cloud.clouddms_v1.types.GetConversionWorkspaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GetConversionWorkspace’ request.
- class google.cloud.clouddms_v1.types.GetMappingRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GetMappingRule’ request.
- name¶
Required. Name of the mapping rule resource to get. Example: conversionWorkspaces/123/mappingRules/rule123
In order to retrieve a previous revision of the mapping rule, also provide the revision ID. Example:
conversionWorkspace/123/mappingRules/rule123@c7cfa2a8c7cfa2a8c7cfa2a8c7cfa2a8
- Type
- class google.cloud.clouddms_v1.types.GetMigrationJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘GetMigrationJob’ request.
- class google.cloud.clouddms_v1.types.GetPrivateConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to get a private connection resource.
- class google.cloud.clouddms_v1.types.ImportMappingRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘ImportMappingRules’ request.
- parent¶
Required. Name of the conversion workspace resource to import the rules to in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
- Type
- rules_format¶
Required. The format of the rules content file.
- rules_files¶
Required. One or more rules files.
- Type
MutableSequence[google.cloud.clouddms_v1.types.ImportMappingRulesRequest.RulesFile]
- auto_commit¶
Required. Should the conversion workspace be committed automatically after the import operation.
- Type
- class RulesFile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetails of a single rules file.
- rules_source_filename¶
Required. The filename of the rules that needs to be converted. The filename is used mainly so that future logs of the import rules job contain it, and can therefore be searched by it.
- Type
- class google.cloud.clouddms_v1.types.ImportRulesFileFormat(value)[source]¶
Bases:
proto.enums.EnumThe 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.
- class google.cloud.clouddms_v1.types.IndexEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIndex is not used as an independent entity, it is retrieved as part of a Table entity.
- table_columns¶
Table columns used as part of the Index, for example B-TREE index should list the columns which constitutes the index.
- Type
MutableSequence[str]
- custom_features¶
Custom engine specific features.
- class google.cloud.clouddms_v1.types.IntComparisonFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFilter based on relation between source value and compare value of type integer in ConditionalColumnSetValue
- value_comparison¶
Required. Relation between source value and compare value
- class google.cloud.clouddms_v1.types.ListConnectionProfilesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘ListConnectionProfiles’ request.
- page_size¶
The maximum number of connection profiles to return. The service may return fewer than this value. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 are coerced to 1000.
- Type
- page_token¶
A page token, received from a previous
ListConnectionProfilescall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListConnectionProfilesmust match the call that provided the page token.- Type
- filter¶
A filter expression that filters connection profiles 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 connection profiles created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify mySql.username = %lt;my_username%gt; to list all connection profiles configured to connect with a specific username.
- Type
- class google.cloud.clouddms_v1.types.ListConnectionProfilesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListConnectionProfiles’ request.
- connection_profiles¶
The response list of connection profiles.
- Type
MutableSequence[google.cloud.clouddms_v1.types.ConnectionProfile]
- next_page_token¶
A token which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.clouddms_v1.types.ListConversionWorkspacesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRetrieve a list of all conversion workspaces in a given project and location.
- page_size¶
The maximum number of conversion workspaces to return. The service may return fewer than this value. If unspecified, at most 50 sets are returned.
- Type
- page_token¶
The nextPageToken value received in the previous call to conversionWorkspaces.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspaces.list must match the call that provided the page token.
- Type
- filter¶
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.
- Type
- class google.cloud.clouddms_v1.types.ListConversionWorkspacesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListConversionWorkspaces’ request.
- conversion_workspaces¶
The list of conversion workspace objects.
- Type
MutableSequence[google.cloud.clouddms_v1.types.ConversionWorkspace]
- next_page_token¶
A token which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.clouddms_v1.types.ListMappingRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRetrieve a list of all mapping rules in a given conversion workspace.
- parent¶
Required. Name of the conversion workspace resource whose mapping rules are listed in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
- Type
- page_size¶
The maximum number of rules to return. The service may return fewer than this value.
- Type
- page_token¶
The nextPageToken value received in the previous call to mappingRules.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 mappingRules.list must match the call that provided the page token.
- Type
- class google.cloud.clouddms_v1.types.ListMappingRulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListMappingRulesRequest’ request.
- mapping_rules¶
The list of conversion workspace mapping rules.
- Type
MutableSequence[google.cloud.clouddms_v1.types.MappingRule]
- class google.cloud.clouddms_v1.types.ListMigrationJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRetrieves a list of all migration jobs in a given project and location.
- page_size¶
The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 are coerced to 1000.
- Type
- page_token¶
The nextPageToken value received in the previous call to migrationJobs.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 migrationJobs.list must match the call that provided the page token.
- Type
- filter¶
A filter expression that filters migration jobs 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 migration jobs created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = “1.2.3.4” to select all migration jobs connecting through the specific SSH tunnel bastion.
- Type
- class google.cloud.clouddms_v1.types.ListMigrationJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListMigrationJobs’ request.
- migration_jobs¶
The list of migration jobs objects.
- Type
MutableSequence[google.cloud.clouddms_v1.types.MigrationJob]
- next_page_token¶
A token which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.clouddms_v1.types.ListPrivateConnectionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to retrieve a list of private connections in a given project and location.
- page_size¶
Maximum number of private connections to return. If unspecified, at most 50 private connections that are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
- Type
- page_token¶
Page token received from a previous
ListPrivateConnectionscall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListPrivateConnectionsmust match the call that provided the page token.- Type
- filter¶
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
- class google.cloud.clouddms_v1.types.ListPrivateConnectionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘ListPrivateConnections’ request.
- private_connections¶
List of private connections.
- Type
MutableSequence[google.cloud.clouddms_v1.types.PrivateConnection]
- next_page_token¶
A token which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.clouddms_v1.types.MappingRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefinition of a transformation that is to be applied to a group of entities in the source schema. Several such transformations can be applied to an entity sequentially to define the corresponding entity in the target schema.
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.
- name¶
Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
- Type
- state¶
Optional. The mapping rule state
- rule_scope¶
Required. The rule scope
- filter¶
Required. The rule filter
- rule_order¶
Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden.
- Type
- revision_id¶
Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string.
- Type
- revision_create_time¶
Output only. The timestamp that the revision was created.
- single_entity_rename¶
Optional. Rule to specify how a single entity should be renamed.
This field is a member of oneof
details.
- multi_entity_rename¶
Optional. Rule to specify how multiple entities should be renamed.
This field is a member of oneof
details.
- entity_move¶
Optional. Rule to specify how multiple entities should be relocated into a different schema.
This field is a member of oneof
details.
- single_column_change¶
Optional. Rule to specify how a single column is converted.
This field is a member of oneof
details.
- multi_column_data_type_change¶
Optional. Rule to specify how multiple columns should be converted to a different data type.
This field is a member of oneof
details.
- conditional_column_set_value¶
Optional. Rule to specify how the data contained in a column should be transformed (such as trimmed, rounded, etc) provided that the data meets certain criteria.
This field is a member of oneof
details.
- convert_rowid_column¶
Optional. Rule to specify how multiple tables should be converted with an additional rowid column.
This field is a member of oneof
details.
- set_table_primary_key¶
Optional. Rule to specify the primary key for a table
This field is a member of oneof
details.
- single_package_change¶
Optional. Rule to specify how a single package is converted.
This field is a member of oneof
details.
- source_sql_change¶
Optional. Rule to change the sql code for an entity, for example, function, procedure.
This field is a member of oneof
details.
- filter_table_columns¶
Optional. Rule to specify the list of columns to include or exclude from a table.
This field is a member of oneof
details.
- class State(value)[source]¶
Bases:
proto.enums.EnumThe current mapping rule state such as enabled, disabled or deleted.
- Values:
- STATE_UNSPECIFIED (0):
The state of the mapping rule is unknown.
- ENABLED (1):
The rule is enabled.
- DISABLED (2):
The rule is disabled.
- DELETED (3):
The rule is logically deleted.
- class google.cloud.clouddms_v1.types.MappingRuleFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields.
- parent_entity¶
Optional. The rule should be applied to entities whose parent entity (fully qualified name) matches the given value. For example, if the rule applies to a table entity, the expected value should be a schema (schema). If the rule applies to a column or index entity, the expected value can be either a schema (schema) or a table (schema.table)
- Type
- entity_name_prefix¶
Optional. The rule should be applied to entities whose non-qualified name starts with the given prefix.
- Type
- entity_name_suffix¶
Optional. The rule should be applied to entities whose non-qualified name ends with the given suffix.
- Type
- entity_name_contains¶
Optional. The rule should be applied to entities whose non-qualified name contains the given string.
- Type
- class google.cloud.clouddms_v1.types.MaterializedViewEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMaterializedView’s parent is a schema.
- custom_features¶
Custom engine specific features.
- class google.cloud.clouddms_v1.types.MigrationJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents 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.
- name¶
The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
- Type
- create_time¶
Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.
- update_time¶
Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.
- labels¶
The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of “key”: “value” pairs.
Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }.
- state¶
The current migration job state.
- phase¶
Output only. The current migration job phase.
- type_¶
Required. The migration job type.
- dump_path¶
The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the “dump_flags” field are mutually exclusive.
- Type
- dump_flags¶
The initial dump flags. This field and the “dump_path” field are mutually exclusive.
- reverse_ssh_connectivity¶
The details needed to communicate to the source over Reverse SSH tunnel connectivity.
This field is a member of oneof
connectivity.
- vpc_peering_connectivity¶
The details of the VPC network that the source database is located in.
This field is a member of oneof
connectivity.
- static_ip_connectivity¶
static ip connectivity data (default, no additional details needed).
This field is a member of oneof
connectivity.
- duration¶
Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by ‘s’. Example:
“3.5s”.
- error¶
Output only. The error details in case of state FAILED.
- Type
google.rpc.status_pb2.Status
- source_database¶
The database engine type and provider of the source.
- destination_database¶
The database engine type and provider of the destination.
- end_time¶
Output only. If the migration job is completed, the time when it was completed.
- conversion_workspace¶
The conversion workspace used by the migration.
- filter¶
This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
- Type
- cmek_key_name¶
The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for:
Mysql to Mysql (use the cmek field in the cloudsql connection profile instead).
PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead).
PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
- Type
- performance_config¶
Optional. Data dump parallelism settings used by the migration. Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
- class DumpFlag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDump flag definition.
- class DumpFlags(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDump flags definition.
- dump_flags¶
The flags for the initial dump.
- Type
MutableSequence[google.cloud.clouddms_v1.types.MigrationJob.DumpFlag]
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class PerformanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePerformance configuration definition.
- dump_parallel_level¶
Initial dump parallelism level.
- class DumpParallelLevel(value)[source]¶
Bases:
proto.enums.EnumDescribes the parallelism level during initial dump.
- Values:
- DUMP_PARALLEL_LEVEL_UNSPECIFIED (0):
Unknown dump parallel level. Will be defaulted to OPTIMAL.
- MIN (1):
Minimal parallel level.
- OPTIMAL (2):
Optimal parallel level.
- MAX (3):
Maximum parallel level.
- class Phase(value)[source]¶
Bases:
proto.enums.EnumThe current migration job phase.
- Values:
- PHASE_UNSPECIFIED (0):
The phase of the migration job is unknown.
- FULL_DUMP (1):
The migration job is in the full dump phase.
- CDC (2):
The migration job is CDC phase.
- PROMOTE_IN_PROGRESS (3):
The migration job is running the promote phase.
- WAITING_FOR_SOURCE_WRITES_TO_STOP (4):
Only RDS flow - waiting for source writes to stop
- PREPARING_THE_DUMP (5):
Only RDS flow - the sources writes stopped, waiting for dump to begin
- class State(value)[source]¶
Bases:
proto.enums.EnumThe current migration job states.
- Values:
- STATE_UNSPECIFIED (0):
The state of the migration job is unknown.
- MAINTENANCE (1):
The migration job is down for maintenance.
- DRAFT (2):
The migration job is in draft mode and no resources are created.
- CREATING (3):
The migration job is being created.
- NOT_STARTED (4):
The migration job is created and not started.
- RUNNING (5):
The migration job is running.
- FAILED (6):
The migration job failed.
- COMPLETED (7):
The migration job has been completed.
- DELETING (8):
The migration job is being deleted.
- STOPPING (9):
The migration job is being stopped.
- STOPPED (10):
The migration job is currently stopped.
- DELETED (11):
The migration job has been deleted.
- UPDATING (12):
The migration job is being updated.
- STARTING (13):
The migration job is starting.
- RESTARTING (14):
The migration job is restarting.
- RESUMING (15):
The migration job is resuming.
- class Type(value)[source]¶
Bases:
proto.enums.EnumThe type of migration job (one-time or continuous).
- Values:
- TYPE_UNSPECIFIED (0):
The type of the migration job is unknown.
- ONE_TIME (1):
The migration job is a one time migration.
- CONTINUOUS (2):
The migration job is a continuous migration.
- class google.cloud.clouddms_v1.types.MigrationJobVerificationError(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageError message of a verification Migration job.
- error_code¶
Output only. An instance of ErrorCode specifying the error that occurred.
- error_message¶
Output only. A formatted message with further details about the error and a CTA.
- Type
- error_detail_message¶
Output only. A specific detailed error message, if supplied by the engine.
- Type
- class ErrorCode(value)[source]¶
Bases:
proto.enums.EnumA general error code describing the type of error that occurred.
- Values:
- ERROR_CODE_UNSPECIFIED (0):
An unknown error occurred
- CONNECTION_FAILURE (1):
We failed to connect to one of the connection profile.
- AUTHENTICATION_FAILURE (2):
We failed to authenticate to one of the connection profile.
- INVALID_CONNECTION_PROFILE_CONFIG (3):
One of the involved connection profiles has an invalid configuration.
- VERSION_INCOMPATIBILITY (4):
The versions of the source and the destination are incompatible.
- CONNECTION_PROFILE_TYPES_INCOMPATIBILITY (5):
The types of the source and the destination are incompatible.
- NO_PGLOGICAL_INSTALLED (7):
No pglogical extension installed on databases, applicable for postgres.
- PGLOGICAL_NODE_ALREADY_EXISTS (8):
pglogical node already exists on databases, applicable for postgres.
- INVALID_WAL_LEVEL (9):
The value of parameter wal_level is not set to logical.
- INVALID_SHARED_PRELOAD_LIBRARY (10):
The value of parameter shared_preload_libraries does not include pglogical.
- INSUFFICIENT_MAX_REPLICATION_SLOTS (11):
The value of parameter max_replication_slots is not sufficient.
- INSUFFICIENT_MAX_WAL_SENDERS (12):
The value of parameter max_wal_senders is not sufficient.
- INSUFFICIENT_MAX_WORKER_PROCESSES (13):
The value of parameter max_worker_processes is not sufficient.
- UNSUPPORTED_EXTENSIONS (14):
Extensions installed are either not supported or having unsupported versions.
- UNSUPPORTED_MIGRATION_TYPE (15):
Unsupported migration type.
- INVALID_RDS_LOGICAL_REPLICATION (16):
Invalid RDS logical replication.
- UNSUPPORTED_GTID_MODE (17):
The gtid_mode is not supported, applicable for MySQL.
- UNSUPPORTED_TABLE_DEFINITION (18):
The table definition is not support due to missing primary key or replica identity.
- UNSUPPORTED_DEFINER (19):
The definer is not supported.
- CANT_RESTART_RUNNING_MIGRATION (21):
Migration is already running at the time of restart request.
- SOURCE_ALREADY_SETUP (23):
The source already has a replication setup.
- TABLES_WITH_LIMITED_SUPPORT (24):
The source has tables with limited support. E.g. PostgreSQL tables without primary keys.
- UNSUPPORTED_DATABASE_LOCALE (25):
The source uses an unsupported locale.
- UNSUPPORTED_DATABASE_FDW_CONFIG (26):
The source uses an unsupported Foreign Data Wrapper configuration.
- ERROR_RDBMS (27):
There was an underlying RDBMS error.
- SOURCE_SIZE_EXCEEDS_THRESHOLD (28):
The source DB size in Bytes exceeds a certain threshold. The migration might require an increase of quota, or might not be supported.
- EXISTING_CONFLICTING_DATABASES (29):
The destination DB contains existing databases that are conflicting with those in the source DB.
- PARALLEL_IMPORT_INSUFFICIENT_PRIVILEGE (30):
Insufficient privilege to enable the parallelism configuration.
- class google.cloud.clouddms_v1.types.MultiColumnDatatypeChange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once.
The rule filter field can refer to one or more entities.
The rule scope can be one of:Column.
This rule requires additional filters to be specified beyond the basic rule filter field, which is the source data type, but the rule supports additional filtering capabilities such as the minimum and maximum field length. All additional filters which are specified are required to be met in order for the rule to be applied (logical AND between the fields).
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.
- source_text_filter¶
Optional. Filter for text-based data types like varchar.
This field is a member of oneof
source_filter.
- source_numeric_filter¶
Optional. Filter for fixed point number data types such as NUMERIC/NUMBER.
This field is a member of oneof
source_filter.
- override_length¶
Optional. Column length - e.g. varchar (50) - if not specified and relevant uses the source column length.
- Type
- override_scale¶
Optional. Column scale - when relevant - if not specified and relevant uses the source column scale.
- Type
- override_precision¶
Optional. Column precision - when relevant - if not specified and relevant uses the source column precision.
- Type
- override_fractional_seconds_precision¶
Optional. Column fractional seconds precision:
used only for timestamp based datatypes
if not specified and relevant uses the source column fractional seconds precision.
- Type
- custom_features¶
Optional. Custom engine specific features.
- class google.cloud.clouddms_v1.types.MultiEntityRename(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions to configure rule type MultiEntityRename. The rule is used to rename multiple entities.
The rule filter field can refer to one or more entities.
The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT
- new_name_pattern¶
Optional. The pattern used to generate the new entity’s name. This pattern must include the characters ‘{name}’, which will be replaced with the name of the original entity. For example, the pattern ‘t_{name}’ for an entity name jobs would be converted to ‘t_jobs’.
If unspecified, the default value for this field is ‘{name}’
- Type
- source_name_transformation¶
Optional. Additional transformation that can be done on the source entity name before it is being used by the new_name_pattern, for example lower case. If no transformation is desired, use NO_TRANSFORMATION
- class google.cloud.clouddms_v1.types.MySqlConnectionProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies connection parameters required specifically for MySQL databases.
- username¶
Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
- Type
- password¶
Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
- Type
- ssl¶
SSL configuration for the destination to connect to the source database.
- class google.cloud.clouddms_v1.types.NetworkArchitecture(value)[source]¶
Bases:
proto.enums.Enum- 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.
- class google.cloud.clouddms_v1.types.NumericFilterOption(value)[source]¶
Bases:
proto.enums.EnumSpecifies the columns on which numeric filter needs to be applied.
- Values:
- NUMERIC_FILTER_OPTION_UNSPECIFIED (0):
Numeric filter option unspecified
- NUMERIC_FILTER_OPTION_ALL (1):
Numeric filter option that matches all numeric columns.
- NUMERIC_FILTER_OPTION_LIMIT (2):
Numeric filter option that matches columns having numeric datatypes with specified precision and scale within the limited range of filter.
- NUMERIC_FILTER_OPTION_LIMITLESS (3):
Numeric filter option that matches only the numeric columns with no precision and scale specified.
- class google.cloud.clouddms_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the metadata of the long-running operation.
- create_time¶
Output only. The time the operation was created.
- end_time¶
Output only. The time the operation finished running.
- requested_cancellation¶
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
Code.CANCELLED.- Type
- class google.cloud.clouddms_v1.types.OracleConnectionProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies 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.
- username¶
Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
- Type
- password¶
Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
- Type
- ssl¶
SSL configuration for the connection to the source Oracle database.
Only
SERVER_ONLYconfiguration is supported for Oracle SSL.SSL is supported for Oracle versions 12 and above.
- static_service_ip_connectivity¶
Static Service IP connectivity.
This field is a member of oneof
connectivity.
- forward_ssh_connectivity¶
Forward SSH tunnel connectivity.
This field is a member of oneof
connectivity.
- class google.cloud.clouddms_v1.types.PackageEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePackage’s parent is a schema.
- package_body¶
The SQL code which creates the package body. If the package specification has cursors or subprograms, then the package body is mandatory.
- Type
- custom_features¶
Custom engine specific features.
- class google.cloud.clouddms_v1.types.PostgreSqlConnectionProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies 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.
- username¶
Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
- Type
- password¶
Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
- Type
- ssl¶
SSL configuration for the destination to connect to the source database.
- cloud_sql_id¶
If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
- Type
- network_architecture¶
Output only. If the source is a Cloud SQL database, this field indicates the network architecture it’s associated with.
- static_ip_connectivity¶
Static ip connectivity data (default, no additional details needed).
This field is a member of oneof
connectivity.
- class google.cloud.clouddms_v1.types.PrivateConnection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe PrivateConnection resource is used to establish private connectivity with the customer’s network.
- create_time¶
Output only. The create time of the resource.
- update_time¶
Output only. The last update time of the resource.
- labels¶
The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of “key”: “value” pairs.
Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }.
- state¶
Output only. The state of the private connection.
- error¶
Output only. The error details in case of state FAILED.
- Type
google.rpc.status_pb2.Status
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class State(value)[source]¶
Bases:
proto.enums.EnumPrivate Connection state.
- Values:
- STATE_UNSPECIFIED (0):
No description available.
- CREATING (1):
The private connection is in creation state - creating resources.
- CREATED (2):
The private connection has been created with all of its resources.
- FAILED (3):
The private connection creation has failed.
- DELETING (4):
The private connection is being deleted.
- FAILED_TO_DELETE (5):
Delete request has failed, resource is in invalid state.
- DELETED (6):
The private connection has been deleted.
- class google.cloud.clouddms_v1.types.PrivateConnectivity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePrivate Connectivity.
- class google.cloud.clouddms_v1.types.PrivateServiceConnectConnectivity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
- class google.cloud.clouddms_v1.types.PromoteMigrationJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘PromoteMigrationJob’ request.
- class google.cloud.clouddms_v1.types.RestartMigrationJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘RestartMigrationJob’ request.
- class google.cloud.clouddms_v1.types.ResumeMigrationJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘ResumeMigrationJob’ request.
- class google.cloud.clouddms_v1.types.ReverseSshConnectivity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe 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.
- vm_ip¶
Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- Type
- vm_port¶
Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- Type
- vm¶
The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- Type
- class google.cloud.clouddms_v1.types.RollbackConversionWorkspaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘RollbackConversionWorkspace’ request.
- class google.cloud.clouddms_v1.types.RoundToScale(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThis allows the data to change scale, for example if the source is 2 digits after the decimal point, specify round to scale value = 2. If for example the value needs to be converted to an integer, use round to scale value = 0.
- class google.cloud.clouddms_v1.types.SchemaEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSchema 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.
- custom_features¶
Custom engine specific features.
- class google.cloud.clouddms_v1.types.SearchBackgroundJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘SearchBackgroundJobs’ request.
- conversion_workspace¶
Required. Name of the conversion workspace resource whose jobs are listed, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
- Type
- return_most_recent_per_job_type¶
Optional. Whether or not to return just the most recent job per job type,
- Type
- max_size¶
Optional. The maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 100 jobs are returned. The maximum value is 100; values above 100 are coerced to 100.
- Type
- completed_until_time¶
Optional. If provided, only returns jobs that completed until (not including) the given timestamp.
- class google.cloud.clouddms_v1.types.SearchBackgroundJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘SearchBackgroundJobs’ request.
- jobs¶
The list of conversion workspace mapping rules.
- Type
MutableSequence[google.cloud.clouddms_v1.types.BackgroundJobLogEntry]
- class google.cloud.clouddms_v1.types.SeedConversionWorkspaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest 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.
- name¶
Name of the conversion workspace resource to seed with new database structure, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
- Type
- auto_commit¶
Should the conversion workspace be committed automatically after the seed operation.
- Type
- class google.cloud.clouddms_v1.types.SequenceEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSequence’s parent is a schema.
- start_value¶
Start number for the sequence represented as bytes to accommodate large. numbers
- Type
- max_value¶
Maximum number for the sequence represented as bytes to accommodate large. numbers
- Type
- min_value¶
Minimum number for the sequence represented as bytes to accommodate large. numbers
- Type
- custom_features¶
Custom engine specific features.
- class google.cloud.clouddms_v1.types.SetTablePrimaryKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table.
The rule filter field can refer to one entity.
The rule scope can be one of: Table.
- class google.cloud.clouddms_v1.types.SingleColumnChange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions to configure rule type SingleColumnChange. The rule is used to change the properties of a column.
The rule filter field can refer to one entity.
The rule scope can be one of: Column.
When using this rule, if a field is not specified than the destination column’s configuration will be the same as the one in the source column..
- fractional_seconds_precision¶
Optional. Column fractional seconds precision - e.g. 2 as in timestamp (2) - when relevant.
- Type
- array_length¶
Optional. The length of the array, only relevant if the column type is an array.
- Type
- custom_features¶
Optional. Custom engine specific features.
- class google.cloud.clouddms_v1.types.SingleEntityRename(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions to configure rule type SingleEntityRename. The rule is used to rename an entity.
The rule filter field can refer to only one entity.
The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym
- class google.cloud.clouddms_v1.types.SinglePackageChange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions to configure rule type SinglePackageChange. The rule is used to alter the sql code for a package entities.
The rule filter field can refer to one entity.
The rule scope can be: Package
- class google.cloud.clouddms_v1.types.SourceNumericFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFilter for fixed point number data types such as NUMERIC/NUMBER
- source_min_scale_filter¶
Optional. The filter will match columns with scale greater than or equal to this number.
- Type
- source_max_scale_filter¶
Optional. The filter will match columns with scale smaller than or equal to this number.
- Type
- source_min_precision_filter¶
Optional. The filter will match columns with precision greater than or equal to this number.
- Type
- source_max_precision_filter¶
Optional. The filter will match columns with precision smaller than or equal to this number.
- Type
- numeric_filter_option¶
Required. Enum to set the option defining the datatypes numeric filter has to be applied to
- class google.cloud.clouddms_v1.types.SourceSqlChange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions to configure rule type SourceSqlChange. The rule is used to alter the sql code for database entities.
The rule filter field can refer to one entity.
The rule scope can be: StoredProcedure, Function, Trigger, View
- class google.cloud.clouddms_v1.types.SourceTextFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFilter for text-based data types like varchar.
- source_min_length_filter¶
Optional. The filter will match columns with length greater than or equal to this number.
- Type
- class google.cloud.clouddms_v1.types.SqlAclEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn 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.
- expire_time¶
The time when this access control entry expires in RFC 3339 format, for example:
2012-11-15T16:19:00.094Z.This field is a member of oneof
expiration.
- class google.cloud.clouddms_v1.types.SqlIpConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIP Management configuration.
- enable_ipv4¶
Whether the instance should be assigned an IPv4 address or not.
- private_network¶
The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example,
projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set.- Type
- allocated_ip_range¶
Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can’t be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant.
- Type
- require_ssl¶
Whether SSL connections over IP should be enforced or not.
- authorized_networks¶
The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as ‘slash’ notation (e.g.
192.168.100.0/24).- Type
MutableSequence[google.cloud.clouddms_v1.types.SqlAclEntry]
- class google.cloud.clouddms_v1.types.SshScript(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘GenerateSshScript’ request.
- class google.cloud.clouddms_v1.types.SslConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSSL configuration information.
- type_¶
Output only. The ssl config type according to ‘client_key’, ‘client_certificate’ and ‘ca_certificate’.
- client_key¶
Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the ‘client_certificate’ field is mandatory.
- Type
- client_certificate¶
Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the ‘client_key’ field is mandatory.
- Type
- ca_certificate¶
Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server’s certificate. The replica will use this certificate to verify it’s connecting to the right host.
- Type
- class SslType(value)[source]¶
Bases:
proto.enums.EnumSpecifies The kind of ssl configuration used.
- Values:
- SSL_TYPE_UNSPECIFIED (0):
Unspecified.
- SERVER_ONLY (1):
Only ‘ca_certificate’ specified.
- SERVER_CLIENT (2):
Both server (‘ca_certificate’), and client (‘client_key’, ‘client_certificate’) specified.
- class google.cloud.clouddms_v1.types.StartMigrationJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘StartMigrationJob’ request.
- class google.cloud.clouddms_v1.types.StaticIpConnectivity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe 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.
- class google.cloud.clouddms_v1.types.StaticServiceIpConnectivity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStatic IP address connectivity configured on service project.
- class google.cloud.clouddms_v1.types.StopMigrationJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘StopMigrationJob’ request.
- class google.cloud.clouddms_v1.types.StoredProcedureEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStored procedure’s parent is a schema.
- custom_features¶
Custom engine specific features.
- class google.cloud.clouddms_v1.types.SynonymEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSynonym’s parent is a schema.
- source_type¶
The type of the entity for which the synonym is being created (usually a table or a sequence).
- custom_features¶
Custom engine specific features.
- class google.cloud.clouddms_v1.types.TableEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTable’s parent is a schema.
- columns¶
Table columns.
- Type
MutableSequence[google.cloud.clouddms_v1.types.ColumnEntity]
- constraints¶
Table constraints.
- Type
MutableSequence[google.cloud.clouddms_v1.types.ConstraintEntity]
- indices¶
Table indices.
- Type
MutableSequence[google.cloud.clouddms_v1.types.IndexEntity]
- triggers¶
Table triggers.
- Type
MutableSequence[google.cloud.clouddms_v1.types.TriggerEntity]
- custom_features¶
Custom engine specific features.
- class google.cloud.clouddms_v1.types.TcpProxyScript(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ‘GenerateTcpProxyScript’ request.
- class google.cloud.clouddms_v1.types.TriggerEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTrigger is not used as an independent entity, it is retrieved as part of a Table entity.
- triggering_events¶
The DML, DDL, or database events that fire the trigger, for example INSERT, UPDATE.
- Type
MutableSequence[str]
- trigger_type¶
Indicates when the trigger fires, for example BEFORE STATEMENT, AFTER EACH ROW.
- Type
- custom_features¶
Custom engine specific features.
- class google.cloud.clouddms_v1.types.UDTEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUDT’s parent is a schema.
- custom_features¶
Custom engine specific features.
- class google.cloud.clouddms_v1.types.UpdateConnectionProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘UpdateConnectionProfile’ request.
- update_mask¶
Required. Field mask is used to specify the fields to be overwritten by the update in the conversion workspace resource.
- connection_profile¶
Required. The connection profile parameters to update.
- request_id¶
Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.
It is recommended to always set this value to a UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- Type
- validate_only¶
Optional. Only validate the connection profile, but don’t update any resources. The default is false. Only supported for Oracle connection profiles.
- Type
- class google.cloud.clouddms_v1.types.UpdateConversionWorkspaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘UpdateConversionWorkspace’ request.
- update_mask¶
Required. Field mask is used to specify the fields to be overwritten by the update in the conversion workspace resource.
- conversion_workspace¶
Required. The conversion workspace parameters to update.
- request_id¶
A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.
It is recommended to always set this value to a UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- Type
- class google.cloud.clouddms_v1.types.UpdateMigrationJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘UpdateMigrationJob’ request.
- update_mask¶
Required. Field mask is used to specify the fields to be overwritten by the update in the conversion workspace resource.
- migration_job¶
Required. The migration job parameters to update.
- request_id¶
A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.
It is recommended to always set this value to a UUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- Type
- class google.cloud.clouddms_v1.types.ValueComparison(value)[source]¶
Bases:
proto.enums.EnumEnum used by IntComparisonFilter and DoubleComparisonFilter to indicate the relation between source value and compare value.
- Values:
- VALUE_COMPARISON_UNSPECIFIED (0):
Value comparison unspecified.
- VALUE_COMPARISON_IF_VALUE_SMALLER_THAN (1):
Value is smaller than the Compare value.
- VALUE_COMPARISON_IF_VALUE_SMALLER_EQUAL_THAN (2):
Value is smaller or equal than the Compare value.
- VALUE_COMPARISON_IF_VALUE_LARGER_THAN (3):
Value is larger than the Compare value.
- VALUE_COMPARISON_IF_VALUE_LARGER_EQUAL_THAN (4):
Value is larger or equal than the Compare value.
- class google.cloud.clouddms_v1.types.ValueListFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA list of values to filter by in ConditionalColumnSetValue
- value_present_list¶
Required. Indicates whether the filter matches rows with values that are present in the list or those with values not present in it.
- class google.cloud.clouddms_v1.types.ValuePresentInList(value)[source]¶
Bases:
proto.enums.EnumEnum used by ValueListFilter to indicate whether the source value is in the supplied list
- Values:
- VALUE_PRESENT_IN_LIST_UNSPECIFIED (0):
Value present in list unspecified
- VALUE_PRESENT_IN_LIST_IF_VALUE_LIST (1):
If the source value is in the supplied list at value_list
- VALUE_PRESENT_IN_LIST_IF_VALUE_NOT_LIST (2):
If the source value is not in the supplied list at value_list
- class google.cloud.clouddms_v1.types.ValueTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescription of data transformation during migration as part of the ConditionalColumnSetValue.
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.
- int_comparison¶
Optional. Filter on relation between source value and compare value of type integer.
This field is a member of oneof
filter.
- double_comparison¶
Optional. Filter on relation between source value and compare value of type double.
This field is a member of oneof
filter.
- assign_specific_value¶
Optional. Set to a specific value (value is converted to fit the target data type)
This field is a member of oneof
action.
- assign_min_value¶
Optional. Set to min_value - if integer or numeric, will use int.minvalue, etc
This field is a member of oneof
action.
- assign_max_value¶
Optional. Set to max_value - if integer or numeric, will use int.maxvalue, etc
This field is a member of oneof
action.
- class google.cloud.clouddms_v1.types.VerifyMigrationJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘VerifyMigrationJob’ request.
- update_mask¶
Optional. Field mask is used to specify the changed fields to be verified. It will not update the migration job.
- migration_job¶
Optional. The changed migration job parameters to verify. It will not update the migration job.
- class google.cloud.clouddms_v1.types.ViewEntity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageView’s parent is a schema.
- custom_features¶
Custom engine specific features.
- constraints¶
View constraints.
- Type
MutableSequence[google.cloud.clouddms_v1.types.ConstraintEntity]
- class google.cloud.clouddms_v1.types.VmCreationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVM creation configuration message
- class google.cloud.clouddms_v1.types.VmSelectionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVM selection configuration message
- class google.cloud.clouddms_v1.types.VpcPeeringConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe VPC peering configuration is used to create VPC peering with the consumer’s VPC.
- vpc_name¶
Required. Fully qualified name of the VPC that Database Migration Service will peer to.
- Type
- class google.cloud.clouddms_v1.types.VpcPeeringConnectivity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe 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.
