View Source API Reference google_api_data_migration v0.11.0

Modules

API client metadata for GoogleApi.DataMigration.V1.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.DataMigration.V1.

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

Settings for creating an AlloyDB cluster.

Request message for 'ApplyConversionWorkspace' request.

Apply a hash function on the value.

Details regarding an Apply background job.

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

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Execution log of a background job.

Associates members, or principals, with a role.

The request message for Operations.CancelOperation.

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.

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.

A connection profile definition.

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.

Request message for 'ConvertConversionWorkspace' request.

Details regarding a Convert background job.

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.

Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see Data cache overview in Cloud SQL documentation.

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.

DatabaseInstance acts as a parent entity to other database entities.

A message defining the database engine and provider.

Request message for 'DemoteDestination' request.

Response message for 'DescribeConversionWorkspaceRevisions' request.

Response message for 'DescribeDatabaseEntities' request.

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

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

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

A single DDL statement for a specific entity

Issue related to the entity.

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

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

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.

Function's parent is a schema.

Request message for 'GenerateSshScript' request.

Request message for 'GenerateTcpProxyScript' request.

Represents the metadata of the long-running operation.

Request message for 'ImportMappingRules' request.

Details regarding an Import Rules background job.

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

Response message for 'ListConnectionProfiles' request.

Response message for 'ListConversionWorkspaces' request.

The response message for Locations.ListLocations.

Response message for 'ListMappingRulesRequest' request.

Response message for 'ListMigrationJobs' request.

The response message for Operations.ListOperations.

Response message for 'ListPrivateConnections' request.

A resource that represents a Google Cloud location.

MachineConfig describes the configuration of a machine.

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.

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.

Error message of a verification Migration job.

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

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.

This resource represents a long-running operation that is the result of a network API call.

Specifies connection parameters required specifically for Oracle databases.

Package's parent is a schema.

Performance configuration definition.

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.

Specifies connection parameters required specifically for PostgreSQL databases.

Settings for the cluster's primary instance

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

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.

Details of a single rules file.

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.

Response message for 'SearchBackgroundJobs' request.

Request message for 'SeedConversionWorkspace' request.

Details regarding a Seed background job.

Sequence's parent is a schema.

Request message for SetIamPolicy method.

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.

IP Management configuration.

Specifies the backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.

Specifies connection parameters required specifically for SQL Server databases.

Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.

Encryption settings for the SQL Server database.

Configuration for homogeneous migration to Cloud SQL for SQL Server.

Response message for 'GenerateSshScript' request.

SSL configuration information.

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.

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

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.

Request message for TestIamPermissions method.

Response message for TestIamPermissions method.

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

UDT's parent is a schema.

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

A list of values to filter by in ConditionalColumnSetValue

Description of data transformation during migration as part of the ConditionalColumnSetValue.

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 client metadata for GoogleApi.DataMigration.V1beta1.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.DataMigration.V1beta1.

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Associates members, or principals, with a role.

The request message for Operations.CancelOperation.

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.

A message defining the database engine and provider.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

Request message for 'GenerateSshScript' request.

Represents the metadata of the long-running operation.

Response message for 'ListConnectionProfiles' request.

The response message for Locations.ListLocations.

Response message for 'ListMigrationJobs' request.

The response message for Operations.ListOperations.

A resource that represents a Google Cloud location.

Represents a Database Migration Service migration job object.

Error message of a verification Migration job.

Specifies connection parameters required specifically for MySQL databases.

This resource represents a long-running operation that is the result of a network API call.

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.

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/v1beta1/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 SetIamPolicy method.

An entry for an Access Control list.

Response message for 'GenerateSshScript' request.

SSL configuration information.

Request message for 'StartMigrationJob' request.

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

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Request message for 'StopMigrationJob' request.

Request message for TestIamPermissions method.

Response message for TestIamPermissions method.

Request message for 'VerifyMigrationJob' request.

VM creation configuration message

VM selection configuration message

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.