Namespace Google.Apis.DatabaseMigrationService.v1.Data

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.

ApplyJobDetails

Details regarding an Apply background job.

AssignSpecificValue

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.

AuditLogConfig

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.

AuthorizedNetwork

AuthorizedNetwork contains metadata for an authorized network.

BackgroundJobLogEntry

Execution log of a background job.

BinaryLogParser

Configuration to use Binary Log Parser CDC technique.

Binding

Associates members, or principals, with a role.

CancelOperationRequest

The request message for Operations.CancelOperation.

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.

ConnectionProfile

A connection profile definition.

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.

ConvertJobDetails

Details regarding a Convert background job.

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.

DataCacheConfig

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.

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.

DatabaseInstanceEntity

DatabaseInstance acts as a parent entity to other database entities.

DatabaseType

A message defining the database engine and provider.

DemoteDestinationRequest

Request message for 'DemoteDestination' request.

DescribeConversionWorkspaceRevisionsResponse

Response message for 'DescribeConversionWorkspaceRevisions' request.

DescribeDatabaseEntitiesResponse

Response message for 'DescribeDatabaseEntities' request.

DoubleComparisonFilter

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

DumpFlag

Dump flag definition.

DumpFlags

Dump flags definition.

Empty

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

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

EntityDdl

A single DDL statement for a specific entity

EntityIssue

Issue related to the entity.

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

Expr

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.

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.

FunctionEntity

Function's parent is a schema.

GenerateSshScriptRequest

Request message for 'GenerateSshScript' request.

GenerateTcpProxyScriptRequest

Request message for 'GenerateTcpProxyScript' request.

GoogleCloudClouddmsV1OperationMetadata

Represents the metadata of the long-running operation.

ImportMappingRulesRequest

Request message for 'ImportMappingRules' request.

ImportRulesJobDetails

Details regarding an Import Rules background job.

IndexEntity

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

InstanceNetworkConfig

Metadata related to instance level network configuration.

IntComparisonFilter

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

ListConnectionProfilesResponse

Response message for 'ListConnectionProfiles' request.

ListConversionWorkspacesResponse

Response message for 'ListConversionWorkspaces' request.

ListLocationsResponse

The response message for Locations.ListLocations.

ListMappingRulesResponse

Response message for 'ListMappingRulesRequest' request.

ListMigrationJobsResponse

Response message for 'ListMigrationJobs' request.

ListOperationsResponse

The response message for Operations.ListOperations.

ListPrivateConnectionsResponse

Response message for 'ListPrivateConnections' request.

Location

A resource that represents a Google Cloud location.

LogFileDirectories

Configuration to specify the Oracle directories to access the log files.

LogMiner

Configuration to use LogMiner CDC method.

MachineConfig

MachineConfig describes the configuration of a machine.

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.

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.

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

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.

Operation

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

OracleAsmConfig

Configuration for Oracle Automatic Storage Management (ASM) connection.

OracleAsmLogFileAccess

Configuration to use Oracle ASM to access the log files.

OracleConnectionProfile

Specifies connection parameters required specifically for Oracle databases.

OracleSourceConfig

Configuration for Oracle as a source in a migration.

OracleToPostgresConfig

Configuration for heterogeneous Oracle to Cloud SQL for PostgreSQL and Oracle to AlloyDB for PostgreSQL migrations.

PackageEntity

Package's parent is a schema.

PerformanceConfig

Performance configuration definition.

Policy

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
&lt; 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 &lt;
timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3

For a description of IAM and its features, see the IAM documentation.

Position

Issue position.

PostgreSqlConnectionProfile

Specifies connection parameters required specifically for PostgreSQL databases.

PostgresDestinationConfig

Configuration for Postgres as a destination in a migration.

PrimaryInstanceSettings

Settings for the cluster's primary instance

PrivateConnection

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

PrivateConnectivity

Private Connectivity.

PrivateServiceConnectConnectivity

Private Service Connect connectivity

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.

RulesFile

Details of a single rules file.

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.

SearchBackgroundJobsResponse

Response message for 'SearchBackgroundJobs' request.

SeedConversionWorkspaceRequest

Request message for 'SeedConversionWorkspace' request.

SeedJobDetails

Details regarding a Seed background job.

SequenceEntity

Sequence's parent is a schema.

SetIamPolicyRequest

Request message for SetIamPolicy method.

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.

SqlIpConfig

IP Management configuration.

SqlServerBackups

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

SqlServerConnectionProfile

Specifies connection parameters required specifically for SQL Server databases.

SqlServerDatabaseBackup

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

SqlServerEncryptionOptions

Encryption settings for the SQL Server database.

SqlServerHomogeneousMigrationJobConfig

Configuration for homogeneous migration to Cloud SQL for SQL Server.

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.

Status

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.