package google.events.cloud.clouddms.v1

Get desktop application:
View/edit binary Protocol Buffers messages

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

Used in: ConnectionProfile

• string cluster_id = 1

  Required. The AlloyDB cluster ID that this connection profile is associated with.

• optional AlloyDbSettings settings = 2

  Immutable. Metadata used to create the destination AlloyDB cluster.

Settings for creating an AlloyDB cluster.

Used in: AlloyDbConnectionProfile

• string vpc_network = 2

  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.

• map<string, string> labels = 3

  Labels for the AlloyDB cluster created by DMS. An object containing a list of 'key', 'value' pairs.

• optional AlloyDbSettings.PrimaryInstanceSettings primary_instance_settings = 4

Settings for the cluster's primary instance

Used in: AlloyDbSettings

• string id = 1

  Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".

• optional PrimaryInstanceSettings.MachineConfig machine_config = 2

  Configuration for the machines that host the underlying database engine.

• map<string, string> database_flags = 6

  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.

• map<string, string> labels = 7

  Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.

• string private_ip = 8

  Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.

MachineConfig describes the configuration of a machine.

Used in: PrimaryInstanceSettings

• int32 cpu_count = 1

  The number of CPU's in the VM instance.

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

• string user = 1

  The database username.

• bool password_set = 3

  Output only. Indicates if the initial_user.password field has been set.

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

Used in: ConnectionProfile

• string cloud_sql_id = 1

  Output only. The Cloud SQL instance ID that this connection profile is associated with.

• optional CloudSqlSettings settings = 2

  Immutable. Metadata used to create the destination Cloud SQL database.

• string private_ip = 3

  Output only. The Cloud SQL database instance's private IP.

• string public_ip = 4

  Output only. The Cloud SQL database instance's public IP.

• string additional_public_ip = 5

  Output only. The Cloud SQL database instance's additional (outgoing) public IP. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).

Settings for creating a Cloud SQL database instance.

Used in: CloudSqlConnectionProfile

• CloudSqlSettings.SqlDatabaseVersion database_version = 1

  The database engine type and version.

• map<string, string> user_labels = 2

  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" }`.

• string tier = 3

  The tier (or machine type) for this instance, for example: `db-n1-standard-1` (MySQL instances) or `db-custom-1-3840` (PostgreSQL instances). For more information, see [Cloud SQL Instance Settings](https://cloud.google.com/sql/docs/mysql/instance-settings).

• optional protobuf.Int64Value storage_auto_resize_limit = 4

  The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

• CloudSqlSettings.SqlActivationPolicy activation_policy = 5

  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.

• optional SqlIpConfig ip_config = 6

  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.

• optional protobuf.BoolValue auto_storage_increase = 7

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

• map<string, string> database_flags = 8

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

• CloudSqlSettings.SqlDataDiskType data_disk_type = 9

  The type of storage: `PD_SSD` (default) or `PD_HDD`.

• optional protobuf.Int64Value data_disk_size_gb = 10

  The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

• string zone = 11

  The Google Cloud Platform zone where your Cloud SQL database instance is located.

• string secondary_zone = 18

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

• string source_id = 12

  The Database Migration Service source connection profile ID, in the format: `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID`

• bool root_password_set = 14

  Output only. Indicates If this connection profile root password is stored.

• string collation = 15

  The Cloud SQL default instance level collation.

• string cmek_key_name = 16

  The KMS key name used for the csql instance.

• CloudSqlSettings.SqlAvailabilityType availability_type = 17

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

Specifies when the instance should be activated.

Used in: CloudSqlSettings

• SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

  unspecified policy.

• ALWAYS = 1

  The instance is always up and running.

• NEVER = 2

  The instance should never spin up.

The availability type of the given Cloud SQL instance.

Used in: CloudSqlSettings

• SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

  This is an unknown Availability type.

• ZONAL = 1

  Zonal availablility instance.

• REGIONAL = 2

  Regional availability instance.

The storage options for Cloud SQL databases.

Used in: CloudSqlSettings

• SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

  Unspecified.

• PD_SSD = 1

  SSD disk.

• PD_HDD = 2

  HDD disk.

The database engine type and version.

Used in: CloudSqlSettings

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

A connection profile definition.

Used in: ConnectionProfileEventData

• string name = 1

  The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.

• optional protobuf.Timestamp create_time = 2

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

• optional protobuf.Timestamp update_time = 3

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

• map<string, string> labels = 4

  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" }`.

• ConnectionProfile.State state = 5

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

• string display_name = 6

  The connection profile display name.

• oneof connection_profile

  The connection profile definition.

  • MySqlConnectionProfile mysql = 100

    A MySQL database connection profile.

  • PostgreSqlConnectionProfile postgresql = 101

    A PostgreSQL database connection profile.

  • CloudSqlConnectionProfile cloudsql = 102

    A CloudSQL database connection profile.

  • AlloyDbConnectionProfile alloydb = 105

    An AlloyDB cluster connection profile.

• optional rpc.Status error = 7

  Output only. The error details in case of state FAILED.

• DatabaseProvider provider = 8

  The database provider.

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

Used in: ConnectionProfile

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

The CloudEvent raised when a ConnectionProfile is created.

• optional ConnectionProfileEventData data = 1

  The data associated with the event.

The CloudEvent raised when a ConnectionProfile is deleted.

• optional ConnectionProfileEventData data = 1

  The data associated with the event.

The data within all ConnectionProfile events.

Used in: ConnectionProfileCreatedEvent, ConnectionProfileDeletedEvent, ConnectionProfileUpdatedEvent

• optional ConnectionProfile payload = 1

  Optional. The ConnectionProfile event payload. Unset for deletion events.

The CloudEvent raised when a ConnectionProfile is updated.

• optional ConnectionProfileEventData data = 1

  The data associated with the event.

The database engine types.

Used in: DatabaseType

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

The database providers.

Used in: ConnectionProfile, DatabaseType

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

A message defining the database engine and provider.

Used in: MigrationJob

• DatabaseProvider provider = 1

  The database provider.

• DatabaseEngine engine = 2

  The database engine.

Represents a Database Migration Service migration job object.

Used in: MigrationJobEventData

• string name = 1

  The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.

• optional protobuf.Timestamp create_time = 2

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

• optional protobuf.Timestamp update_time = 3

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

• map<string, string> labels = 4

  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" }`.

• string display_name = 5

  The migration job display name.

• MigrationJob.State state = 6

  The current migration job state.

• MigrationJob.Phase phase = 7

  Output only. The current migration job phase.

• MigrationJob.Type type = 8

  Required. The migration job type.

• string dump_path = 9

  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.

• optional MigrationJob.DumpFlags dump_flags = 17

  The initial dump flags. This field and the "dump_path" field are mutually exclusive.

• string source = 10

  Required. The resource name (URI) of the source connection profile.

• string destination = 11

  Required. The resource name (URI) of the destination connection profile.

• oneof connectivity

  The connectivity method.

  • ReverseSshConnectivity reverse_ssh_connectivity = 101

    The details needed to communicate to the source over Reverse SSH tunnel connectivity.

  • VpcPeeringConnectivity vpc_peering_connectivity = 102

    The details of the VPC network that the source database is located in.

  • StaticIpConnectivity static_ip_connectivity = 103

    static ip connectivity data (default, no additional details needed).

• optional protobuf.Duration duration = 12

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

• optional rpc.Status error = 13

  Output only. The error details in case of state FAILED.

• optional DatabaseType source_database = 14

  The database engine type and provider of the source.

• optional DatabaseType destination_database = 15

  The database engine type and provider of the destination.

• optional protobuf.Timestamp end_time = 16

  Output only. If the migration job is completed, the time when it was completed.

Dump flag definition.

Used in: DumpFlags

• string name = 1

  The name of the flag

• string value = 2

  The value of the flag.

Dump flags definition.

Used in: MigrationJob

• repeated DumpFlag dump_flags = 1

  The flags for the initial dump.

The current migration job phase.

Used in: MigrationJob

• 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

The current migration job states.

Used in: MigrationJob

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

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

Used in: MigrationJob

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

The CloudEvent raised when a MigrationJob is created.

• optional MigrationJobEventData data = 1

  The data associated with the event.

The CloudEvent raised when a MigrationJob is deleted.

• optional MigrationJobEventData data = 1

  The data associated with the event.

The data within all MigrationJob events.

Used in: MigrationJobCreatedEvent, MigrationJobDeletedEvent, MigrationJobUpdatedEvent

• optional MigrationJob payload = 1

  Optional. The MigrationJob event payload. Unset for deletion events.

The CloudEvent raised when a MigrationJob is updated.

• optional MigrationJobEventData data = 1

  The data associated with the event.

Specifies connection parameters required specifically for MySQL databases.

Used in: ConnectionProfile

• string host = 1

  Required. The IP or hostname of the source MySQL database.

• int32 port = 2

  Required. The network port of the source MySQL database.

• string username = 3

  Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

• bool password_set = 5

  Output only. Indicates If this connection profile password is stored.

• optional SslConfig ssl = 6

  SSL configuration for the destination to connect to the source database.

• string cloud_sql_id = 7

  If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

Used in: PostgreSqlConnectionProfile

• NETWORK_ARCHITECTURE_UNSPECIFIED = 0

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

Specifies connection parameters required specifically for PostgreSQL databases.

Used in: ConnectionProfile

• string host = 1

  Required. The IP or hostname of the source PostgreSQL database.

• int32 port = 2

  Required. The network port of the source PostgreSQL database.

• string username = 3

  Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

• bool password_set = 5

  Output only. Indicates If this connection profile password is stored.

• optional SslConfig ssl = 6

  SSL configuration for the destination to connect to the source database.

• string cloud_sql_id = 7

  If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

• NetworkArchitecture network_architecture = 8

  Output only. If the source is a Cloud SQL database, this field indicates the network architecture it's associated with.

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.

Used in: MigrationJob

• string vm_ip = 1

  Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

• int32 vm_port = 2

  Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

• string vm = 3

  The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

• string vpc = 4

  The name of the VPC to peer with the Cloud SQL private network.

An entry for an Access Control list.

Used in: SqlIpConfig

• string value = 1

  The allowlisted value for the access control list.

• oneof expiration

  The access control entry entry expiration.

  • protobuf.Timestamp expire_time = 10

    The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example: `2012-11-15T16:19:00.094Z`.

• string label = 3

  A label to identify this entry.

IP Management configuration.

Used in: CloudSqlSettings

• optional protobuf.BoolValue enable_ipv4 = 1

  Whether the instance should be assigned an IPv4 address or not.

• string private_network = 2

  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.

• optional protobuf.BoolValue require_ssl = 3

  Whether SSL connections over IP should be enforced or not.

• repeated SqlAclEntry authorized_networks = 4

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

SSL configuration information.

Used in: MySqlConnectionProfile, PostgreSqlConnectionProfile

• SslConfig.SslType type = 1

  Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.

Specifies The kind of ssl configuration used.

Used in: SslConfig

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

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.

Used in: MigrationJob

(message has no fields)

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.

Used in: MigrationJob

• string vpc = 1

  The name of the VPC network to peer with the Cloud SQL private network.