Package types (1.9.2)

API documentation for clouddms_v1.types package.

Classes

AlloyDbConnectionProfile

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

AlloyDbSettings

Settings for creating an AlloyDB cluster.

ApplyConversionWorkspaceRequest

Request message for 'ApplyConversionWorkspace' request.

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

ApplyHash

Apply a hash function on the value.

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

AssignSpecificValue

Set to a specific value (value is converted to fit the target data 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

BackgroundJobType

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

Values: BACKGROUND_JOB_TYPE_UNSPECIFIED (0): Unspecified background job type. BACKGROUND_JOB_TYPE_SOURCE_SEED (1): Job to seed from the source database. BACKGROUND_JOB_TYPE_CONVERT (2): Job to convert the source database into a draft of the destination database. BACKGROUND_JOB_TYPE_APPLY_DESTINATION (3): Job to apply the draft tree onto the destination. BACKGROUND_JOB_TYPE_IMPORT_RULES_FILE (5): Job to import and convert mapping rules from an external source such as an ora2pg config file.

CloudSqlConnectionProfile

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

CloudSqlSettings

Settings for creating a Cloud SQL database instance.

ColumnEntity

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

CommitConversionWorkspaceRequest

Request message for 'CommitConversionWorkspace' request.

ConditionalColumnSetValue

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.

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

ConnectionProfile

A connection profile definition.

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

ConstraintEntity

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

ConversionWorkspace

The main conversion workspace resource entity.

ConversionWorkspaceInfo

A conversion workspace's version.

ConvertConversionWorkspaceRequest

Request message for 'ConvertConversionWorkspace' request.

ConvertRowIdToColumn

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.

CreateConnectionProfileRequest

Request message for 'CreateConnectionProfile' request.

CreateConversionWorkspaceRequest

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

CreateMappingRuleRequest

Request message for 'CreateMappingRule' command.

CreateMigrationJobRequest

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

CreatePrivateConnectionRequest

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

DatabaseEngine

The database engine types.

Values: DATABASE_ENGINE_UNSPECIFIED (0): The source database engine of the migration job is unknown. MYSQL (1): The source engine is MySQL. POSTGRESQL (2): The source engine is PostgreSQL. ORACLE (4): The source engine is Oracle.

DatabaseEngineInfo

The type and version of a source or destination database.

DatabaseEntity

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

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

DatabaseEntityType

The type of database entities supported,

Values: DATABASE_ENTITY_TYPE_UNSPECIFIED (0): Unspecified database entity type. DATABASE_ENTITY_TYPE_SCHEMA (1): Schema. DATABASE_ENTITY_TYPE_TABLE (2): Table. DATABASE_ENTITY_TYPE_COLUMN (3): Column. DATABASE_ENTITY_TYPE_CONSTRAINT (4): Constraint. DATABASE_ENTITY_TYPE_INDEX (5): Index. DATABASE_ENTITY_TYPE_TRIGGER (6): Trigger. DATABASE_ENTITY_TYPE_VIEW (7): View. DATABASE_ENTITY_TYPE_SEQUENCE (8): Sequence. DATABASE_ENTITY_TYPE_STORED_PROCEDURE (9): Stored Procedure. DATABASE_ENTITY_TYPE_FUNCTION (10): Function. DATABASE_ENTITY_TYPE_SYNONYM (11): Synonym. DATABASE_ENTITY_TYPE_DATABASE_PACKAGE (12): Package. DATABASE_ENTITY_TYPE_UDT (13): UDT. DATABASE_ENTITY_TYPE_MATERIALIZED_VIEW (14): Materialized View. DATABASE_ENTITY_TYPE_DATABASE (15): Database.

DatabaseEntityView

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

DatabaseInstanceEntity

DatabaseInstance acts as a parent entity to other database entities.

DatabaseProvider

The database providers.

Values: DATABASE_PROVIDER_UNSPECIFIED (0): The database provider is unknown. CLOUDSQL (1): CloudSQL runs the database. RDS (2): RDS runs the database. AURORA (3): Amazon Aurora. ALLOYDB (4): AlloyDB.

DatabaseType

A message defining the database engine and provider.

DeleteConnectionProfileRequest

Request message for 'DeleteConnectionProfile' request.

DeleteConversionWorkspaceRequest

Request message for 'DeleteConversionWorkspace' request.

DeleteMappingRuleRequest

Request message for 'DeleteMappingRule' request.

DeleteMigrationJobRequest

Request message for 'DeleteMigrationJob' request.

DeletePrivateConnectionRequest

Request message to delete a private connection.

DescribeConversionWorkspaceRevisionsRequest

Request message for 'DescribeConversionWorkspaceRevisions' request.

DescribeConversionWorkspaceRevisionsResponse

Response message for 'DescribeConversionWorkspaceRevisions' request.

DescribeDatabaseEntitiesRequest

Request message for 'DescribeDatabaseEntities' request.

DescribeDatabaseEntitiesResponse

Response message for 'DescribeDatabaseEntities' request.

DoubleComparisonFilter

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

EntityDdl

A single DDL statement for a specific entity

EntityIssue

Issue related to the entity.

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

EntityMapping

Details of the mappings of a database entity.

EntityMappingLogEntry

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

EntityMove

Options to configure rule type EntityMove. 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

EntityNameTransformation

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

FetchStaticIpsRequest

Request message for 'FetchStaticIps' request.

FetchStaticIpsResponse

Response message for a 'FetchStaticIps' request.

FilterTableColumns

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.

ForwardSshTunnelConnectivity

Forward SSH Tunnel connectivity.

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

FunctionEntity

Function's parent is a schema.

GenerateSshScriptRequest

Request message for 'GenerateSshScript' request.

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

GenerateTcpProxyScriptRequest

Request message for 'GenerateTcpProxyScript' request.

GetConnectionProfileRequest

Request message for 'GetConnectionProfile' request.

GetConversionWorkspaceRequest

Request message for 'GetConversionWorkspace' request.

GetMappingRuleRequest

Request message for 'GetMappingRule' request.

GetMigrationJobRequest

Request message for 'GetMigrationJob' request.

GetPrivateConnectionRequest

Request message to get a private connection resource.

ImportMappingRulesRequest

Request message for 'ImportMappingRules' request.

ImportRulesFileFormat

The format for the import rules file.

Values: IMPORT_RULES_FILE_FORMAT_UNSPECIFIED (0): Unspecified rules format. IMPORT_RULES_FILE_FORMAT_HARBOUR_BRIDGE_SESSION_FILE (1): HarbourBridge session file. IMPORT_RULES_FILE_FORMAT_ORATOPG_CONFIG_FILE (2): Ora2Pg configuration file.

IndexEntity

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

IntComparisonFilter

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

ListConnectionProfilesRequest

Request message for 'ListConnectionProfiles' request.

ListConnectionProfilesResponse

Response message for 'ListConnectionProfiles' request.

ListConversionWorkspacesRequest

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

ListConversionWorkspacesResponse

Response message for 'ListConversionWorkspaces' request.

ListMappingRulesRequest

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

ListMappingRulesResponse

Response message for 'ListMappingRulesRequest' request.

ListMigrationJobsRequest

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

ListMigrationJobsResponse

Response message for 'ListMigrationJobs' request.

ListPrivateConnectionsRequest

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

ListPrivateConnectionsResponse

Response message for 'ListPrivateConnections' request.

MappingRule

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.

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

MappingRuleFilter

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.

MaterializedViewEntity

MaterializedView's parent is a schema.

MigrationJob

Represents a Database Migration Service migration job object.

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

MigrationJobVerificationError

Error message of a verification Migration job.

MultiColumnDatatypeChange

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

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

MultiEntityRename

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

MySqlConnectionProfile

Specifies connection parameters required specifically for MySQL databases.

NetworkArchitecture

Values: NETWORK_ARCHITECTURE_UNSPECIFIED (0): No description available. NETWORK_ARCHITECTURE_OLD_CSQL_PRODUCER (1): Instance is in Cloud SQL's old producer network architecture. NETWORK_ARCHITECTURE_NEW_CSQL_PRODUCER (2): Instance is in Cloud SQL's new producer network architecture.

NumericFilterOption

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

OperationMetadata

Represents the metadata of the long-running operation.

OracleConnectionProfile

Specifies connection parameters required specifically for Oracle databases.

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

PackageEntity

Package's parent is a schema.

PostgreSqlConnectionProfile

Specifies connection parameters required specifically for PostgreSQL databases.

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

PrivateConnection

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

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

PrivateConnectivity

Private Connectivity.

PrivateServiceConnectConnectivity

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

PromoteMigrationJobRequest

Request message for 'PromoteMigrationJob' request.

RestartMigrationJobRequest

Request message for 'RestartMigrationJob' request.

ResumeMigrationJobRequest

Request message for 'ResumeMigrationJob' request.

ReverseSshConnectivity

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

RollbackConversionWorkspaceRequest

Request message for 'RollbackConversionWorkspace' request.

RoundToScale

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

SchemaEntity

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

SearchBackgroundJobsRequest

Request message for 'SearchBackgroundJobs' request.

SearchBackgroundJobsResponse

Response message for 'SearchBackgroundJobs' request.

SeedConversionWorkspaceRequest

Request message for 'SeedConversionWorkspace' request.

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

SequenceEntity

Sequence's parent is a schema.

SetTablePrimaryKey

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.

SingleColumnChange

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

SingleEntityRename

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

SinglePackageChange

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

SourceNumericFilter

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

SourceSqlChange

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

SourceTextFilter

Filter for text-based data types like varchar.

SqlAclEntry

An entry for an Access Control list.

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

SqlIpConfig

IP Management configuration.

SshScript

Response message for 'GenerateSshScript' request.

SslConfig

SSL configuration information.

StartMigrationJobRequest

Request message for 'StartMigrationJob' request.

StaticIpConnectivity

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

StaticServiceIpConnectivity

Static IP address connectivity configured on service project.

StopMigrationJobRequest

Request message for 'StopMigrationJob' request.

StoredProcedureEntity

Stored procedure's parent is a schema.

SynonymEntity

Synonym's parent is a schema.

TableEntity

Table's parent is a schema.

TcpProxyScript

Response message for 'GenerateTcpProxyScript' request.

TriggerEntity

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

UDTEntity

UDT's parent is a schema.

UpdateConnectionProfileRequest

Request message for 'UpdateConnectionProfile' request.

UpdateConversionWorkspaceRequest

Request message for 'UpdateConversionWorkspace' request.

UpdateMigrationJobRequest

Request message for 'UpdateMigrationJob' request.

ValueComparison

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

ValueListFilter

A list of values to filter by in ConditionalColumnSetValue

ValuePresentInList

Enum 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