Package Classes (1.9.5)

Database Migration service

Database Migration service

A pager for iterating through describe_database_entities requests.

This class thinly wraps an initial DescribeDatabaseEntitiesResponse object, and provides an __aiter__ method to iterate through its database_entities field.

If there are more pages, the __aiter__ method will make additional DescribeDatabaseEntities requests and continue to iterate through the database_entities field on the corresponding responses.

All the usual DescribeDatabaseEntitiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through describe_database_entities requests.

This class thinly wraps an initial DescribeDatabaseEntitiesResponse object, and provides an __iter__ method to iterate through its database_entities field.

If there are more pages, the __iter__ method will make additional DescribeDatabaseEntities requests and continue to iterate through the database_entities field on the corresponding responses.

All the usual DescribeDatabaseEntitiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through fetch_static_ips requests.

This class thinly wraps an initial FetchStaticIpsResponse object, and provides an __aiter__ method to iterate through its static_ips field.

If there are more pages, the __aiter__ method will make additional FetchStaticIps requests and continue to iterate through the static_ips field on the corresponding responses.

All the usual FetchStaticIpsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through fetch_static_ips requests.

This class thinly wraps an initial FetchStaticIpsResponse object, and provides an __iter__ method to iterate through its static_ips field.

If there are more pages, the __iter__ method will make additional FetchStaticIps requests and continue to iterate through the static_ips field on the corresponding responses.

All the usual FetchStaticIpsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_connection_profiles requests.

This class thinly wraps an initial ListConnectionProfilesResponse object, and provides an __aiter__ method to iterate through its connection_profiles field.

If there are more pages, the __aiter__ method will make additional ListConnectionProfiles requests and continue to iterate through the connection_profiles field on the corresponding responses.

All the usual ListConnectionProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_connection_profiles requests.

This class thinly wraps an initial ListConnectionProfilesResponse object, and provides an __iter__ method to iterate through its connection_profiles field.

If there are more pages, the __iter__ method will make additional ListConnectionProfiles requests and continue to iterate through the connection_profiles field on the corresponding responses.

All the usual ListConnectionProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_conversion_workspaces requests.

This class thinly wraps an initial ListConversionWorkspacesResponse object, and provides an __aiter__ method to iterate through its conversion_workspaces field.

If there are more pages, the __aiter__ method will make additional ListConversionWorkspaces requests and continue to iterate through the conversion_workspaces field on the corresponding responses.

All the usual ListConversionWorkspacesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_conversion_workspaces requests.

This class thinly wraps an initial ListConversionWorkspacesResponse object, and provides an __iter__ method to iterate through its conversion_workspaces field.

If there are more pages, the __iter__ method will make additional ListConversionWorkspaces requests and continue to iterate through the conversion_workspaces field on the corresponding responses.

All the usual ListConversionWorkspacesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_mapping_rules requests.

This class thinly wraps an initial ListMappingRulesResponse object, and provides an __aiter__ method to iterate through its mapping_rules field.

If there are more pages, the __aiter__ method will make additional ListMappingRules requests and continue to iterate through the mapping_rules field on the corresponding responses.

All the usual ListMappingRulesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_mapping_rules requests.

This class thinly wraps an initial ListMappingRulesResponse object, and provides an __iter__ method to iterate through its mapping_rules field.

If there are more pages, the __iter__ method will make additional ListMappingRules requests and continue to iterate through the mapping_rules field on the corresponding responses.

All the usual ListMappingRulesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_migration_jobs requests.

This class thinly wraps an initial ListMigrationJobsResponse object, and provides an __aiter__ method to iterate through its migration_jobs field.

If there are more pages, the __aiter__ method will make additional ListMigrationJobs requests and continue to iterate through the migration_jobs field on the corresponding responses.

All the usual ListMigrationJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_migration_jobs requests.

This class thinly wraps an initial ListMigrationJobsResponse object, and provides an __iter__ method to iterate through its migration_jobs field.

If there are more pages, the __iter__ method will make additional ListMigrationJobs requests and continue to iterate through the migration_jobs field on the corresponding responses.

All the usual ListMigrationJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_private_connections requests.

This class thinly wraps an initial ListPrivateConnectionsResponse object, and provides an __aiter__ method to iterate through its private_connections field.

If there are more pages, the __aiter__ method will make additional ListPrivateConnections requests and continue to iterate through the private_connections field on the corresponding responses.

All the usual ListPrivateConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_private_connections requests.

This class thinly wraps an initial ListPrivateConnectionsResponse object, and provides an __iter__ method to iterate through its private_connections field.

If there are more pages, the __iter__ method will make additional ListPrivateConnections requests and continue to iterate through the private_connections field on the corresponding responses.

All the usual ListPrivateConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster.

Settings for creating an AlloyDB cluster.

EncryptionConfig describes the encryption config of a cluster that is encrypted with a CMEK (customer-managed encryption key).

The abstract base class for a message.

Settings for the cluster's primary instance

The abstract base class for a message.

The abstract base class for a message.

MachineConfig describes the configuration of a machine.

The username/password for a database user. Used for specifying initial users at cluster creation time.

Request message for 'ApplyConversionWorkspace' request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Apply a hash function on the value.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Set to a specific value (value is converted to fit the target data type)

Execution log of a background job.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Details regarding an Apply background job.

Details regarding a Convert background job.

Details regarding an Import Rules background job.

Final state after a job completes.

Details regarding a Seed background job.

The types of jobs that can be executed in the background.

Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance.

Settings for creating a Cloud SQL database instance.

The abstract base class for a message.

The edition of the given Cloud SQL instance. Can be ENTERPRISE or ENTERPRISE_PLUS.

Specifies when the instance should be activated.

The availability type of the given Cloud SQL instance.

The storage options for Cloud SQL databases.

The database engine type and version.

The abstract base class for a message.

Column is not used as an independent entity, it is retrieved as part of a Table entity.

Request message for 'CommitConversionWorkspace' request.

Options 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A connection profile definition.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

The current connection profile state (e.g. DRAFT, READY, or FAILED).

Constraint is not used as an independent entity, it is retrieved as part of another entity such as Table or View.

The main conversion workspace resource entity.

The abstract base class for a message.

A conversion workspace's version.

Request message for 'ConvertConversionWorkspace' request.

Options 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.

Request message for 'CreateConnectionProfile' request.

Request message to create a new Conversion Workspace in the specified project and region.

Request message for 'CreateMappingRule' command.

Request message to create a new Database Migration Service migration job in the specified project and region.

Request message to create a new private connection in the specified project and region.

The database engine types.

The type and version of a source or destination database.

The base entity type for all the database related entities. The message contains the entity name, the name of its parent, the entity type, and the specific details per entity type.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The type of database entities tree.

The type of database entities supported,

AIP-157 Partial Response view for Database Entity.

DatabaseInstance acts as a parent entity to other database entities.

The database providers.

A message defining the database engine and provider.

Request message for 'DeleteConnectionProfile' request.

Request message for 'DeleteConversionWorkspace' request.

Request message for 'DeleteMappingRule' request.

Request message for 'DeleteMigrationJob' request.

Request message to delete a private connection.

Request message for 'DescribeConversionWorkspaceRevisions' request.

Response message for 'DescribeConversionWorkspaceRevisions' request.

Request message for 'DescribeDatabaseEntities' request.

The type of a tree to return

Response message for 'DescribeDatabaseEntities' request.

Filter based on relation between source value and compare value of type double in ConditionalColumnSetValue

A single DDL statement for a specific entity

Issue related to the entity.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Severity of issue.

Type of issue.

Issue position.

Details of the mappings of a database entity.

A single record of a rule which was used for a mapping.

Options 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

Entity Name Transformation Types

Request message for 'FetchStaticIps' request.

Response message for a 'FetchStaticIps' request.

Options 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.

Forward SSH Tunnel connectivity.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Function's parent is a schema.

Request message for 'GenerateSshScript' request.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for 'GenerateTcpProxyScript' request.

Request message for 'GetConnectionProfile' request.

Request message for 'GetConversionWorkspace' request.

Request message for 'GetMappingRule' request.

Request message for 'GetMigrationJob' request.

Request message to get a private connection resource.

Request message for 'ImportMappingRules' request.

Details of a single rules file.

The format for the import rules file.

Index is not used as an independent entity, it is retrieved as part of a Table entity.

Filter based on relation between source value and compare value of type integer in ConditionalColumnSetValue

Request message for 'ListConnectionProfiles' request.

Response message for 'ListConnectionProfiles' request.

Retrieve a list of all conversion workspaces in a given project and location.

Response message for 'ListConversionWorkspaces' request.

Retrieve a list of all mapping rules in a given conversion workspace.

Response message for 'ListMappingRulesRequest' request.

Retrieves a list of all migration jobs in a given project and location.

Response message for 'ListMigrationJobs' request.

Request message to retrieve a list of private connections in a given project and location.

Response message for 'ListPrivateConnections' request.

Definition 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The current mapping rule state such as enabled, disabled or deleted.

A 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.

MaterializedView's parent is a schema.

Represents a Database Migration Service migration job object.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Dump flag definition.

Dump flags definition.

The abstract base class for a message.

Performance configuration definition.

Describes the parallelism level during initial dump.

The current migration job phase.

The current migration job states.

The type of migration job (one-time or continuous).

Error message of a verification Migration job.

A general error code describing the type of error that occurred.

Options 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Options 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

Specifies connection parameters required specifically for MySQL databases.

Specifies the columns on which numeric filter needs to be applied.

Represents the metadata of the long-running operation.

Specifies connection parameters required specifically for Oracle databases.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Package's parent is a schema.

Specifies connection parameters required specifically for PostgreSQL databases.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The PrivateConnection resource is used to establish private connectivity with the customer's network.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

Private Connection state.

Private Connectivity.

Private Service Connect connectivity <https://cloud.google.com/vpc/docs/private-service-connect#service-attachments>__

Request message for 'PromoteMigrationJob' request.

Request message for 'RestartMigrationJob' request.

Request message for 'ResumeMigrationJob' request.

The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC.

Request message for 'RollbackConversionWorkspace' request.

This allows the data to change scale, for example if the source is 2 digits after the decimal point, specify round to scale value = 2. If for example the value needs to be converted to an integer, use round to scale value = 0.

Schema typically has no parent entity, but can have a parent entity DatabaseInstance (for database engines which support it). For some database engines, the terms schema and user can be used interchangeably when they refer to a namespace or a collection of other database entities. Can store additional information which is schema specific.

Request message for 'SearchBackgroundJobs' request.

Response message for 'SearchBackgroundJobs' request.

Request message for 'SeedConversionWorkspace' request.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Sequence's parent is a schema.

Options 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.

Options 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..

Options 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

Options 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

Filter for fixed point number data types such as NUMERIC/NUMBER

Options 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

Filter for text-based data types like varchar.

An entry for an Access Control list.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

IP Management configuration.

Response message for 'GenerateSshScript' request.

SSL configuration information.

Specifies The kind of ssl configuration used.

Request message for 'StartMigrationJob' request.

The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required.

Static IP address connectivity configured on service project.

Request message for 'StopMigrationJob' request.

Stored procedure's parent is a schema.

Synonym's parent is a schema.

Table's parent is a schema.

Response message for 'GenerateTcpProxyScript' request.

Trigger is not used as an independent entity, it is retrieved as part of a Table entity.

UDT's parent is a schema.

Request message for 'UpdateConnectionProfile' request.

Request message for 'UpdateConversionWorkspace' request.

Request message for 'UpdateMigrationJob' request.

Enum used by IntComparisonFilter and DoubleComparisonFilter to indicate the relation between source value and compare value.

A list of values to filter by in ConditionalColumnSetValue

Enum used by ValueListFilter to indicate whether the source value is in the supplied list

Description 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for 'VerifyMigrationJob' request.

View's parent is a schema.

VM creation configuration message

VM selection configuration message

The VPC peering configuration is used to create VPC peering with the consumer's VPC.

The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC.

API documentation for clouddms_v1.services.data_migration_service.pagers module.