Package-level declarations

Types

Link copied to clipboard
data class AlloyDbConnectionProfileResponse(val clusterId: String, val settings: AlloyDbSettingsResponse)

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

Link copied to clipboard
data class AlloyDbSettingsResponse(val encryptionConfig: EncryptionConfigResponse, val initialUser: UserPasswordResponse, val labels: Map<String, String>, val primaryInstanceSettings: PrimaryInstanceSettingsResponse, val vpcNetwork: String)

Settings for creating an AlloyDB cluster.

Link copied to clipboard
data class AuditConfigResponse(val auditLogConfigs: List<AuditLogConfigResponse>, val service: String)

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.

Link copied to clipboard
data class AuditLogConfigResponse(val exemptedMembers: List<String>, val logType: String)

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.

Link copied to clipboard
data class BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members, or principals, with a role.

Link copied to clipboard
data class CloudSqlConnectionProfileResponse(val additionalPublicIp: String, val cloudSqlId: String, val privateIp: String, val publicIp: String, val settings: CloudSqlSettingsResponse)

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

Link copied to clipboard
data class CloudSqlSettingsResponse(val activationPolicy: String, val autoStorageIncrease: Boolean, val availabilityType: String, val cmekKeyName: String, val collation: String, val dataDiskSizeGb: String, val dataDiskType: String, val databaseFlags: Map<String, String>, val databaseVersion: String, val ipConfig: SqlIpConfigResponse, val rootPassword: String, val rootPasswordSet: Boolean, val secondaryZone: String, val sourceId: String, val storageAutoResizeLimit: String, val tier: String, val userLabels: Map<String, String>, val zone: String)

Settings for creating a Cloud SQL database instance.

Link copied to clipboard
data class ConversionWorkspaceInfoResponse(val commitId: String, val name: String)

A conversion workspace's version.

Link copied to clipboard
data class DatabaseEngineInfoResponse(val engine: String, val version: String)

The type and version of a source or destination database.

Link copied to clipboard
data class DatabaseTypeResponse(val engine: String, val provider: String)

A message defining the database engine and provider.

Link copied to clipboard
data class DumpFlagResponse(val name: String, val value: String)

Dump flag definition.

Link copied to clipboard
data class DumpFlagsResponse(val dumpFlags: List<DumpFlagResponse>)

Dump flags definition.

Link copied to clipboard
data class EncryptionConfigResponse(val kmsKeyName: String)

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

Link copied to clipboard
data class ExprResponse(val description: String, val expression: String, val location: String, val title: String)

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.

Link copied to clipboard
data class ForwardSshTunnelConnectivityResponse(val hostname: String, val password: String, val port: Int, val privateKey: String, val username: String)

Forward SSH Tunnel connectivity.

Link copied to clipboard
data class GetConnectionProfileIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetConnectionProfileResult(val alloydb: AlloyDbConnectionProfileResponse, val cloudsql: CloudSqlConnectionProfileResponse, val createTime: String, val displayName: String, val error: StatusResponse, val labels: Map<String, String>, val mysql: MySqlConnectionProfileResponse, val name: String, val oracle: OracleConnectionProfileResponse, val postgresql: PostgreSqlConnectionProfileResponse, val provider: String, val state: String, val updateTime: String)
Link copied to clipboard
data class GetConversionWorkspaceIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetConversionWorkspaceResult(val createTime: String, val destination: DatabaseEngineInfoResponse, val displayName: String, val globalSettings: Map<String, String>, val hasUncommittedChanges: Boolean, val latestCommitId: String, val latestCommitTime: String, val name: String, val source: DatabaseEngineInfoResponse, val updateTime: String)
Link copied to clipboard
data class GetMigrationJobIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetMigrationJobResult(val cmekKeyName: String, val conversionWorkspace: ConversionWorkspaceInfoResponse, val createTime: String, val destination: String, val destinationDatabase: DatabaseTypeResponse, val displayName: String, val dumpFlags: DumpFlagsResponse, val dumpPath: String, val duration: String, val endTime: String, val error: StatusResponse, val filter: String, val labels: Map<String, String>, val name: String, val phase: String, val reverseSshConnectivity: ReverseSshConnectivityResponse, val source: String, val sourceDatabase: DatabaseTypeResponse, val state: String, val staticIpConnectivity: StaticIpConnectivityResponse, val type: String, val updateTime: String, val vpcPeeringConnectivity: VpcPeeringConnectivityResponse)
Link copied to clipboard
data class GetPrivateConnectionIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetPrivateConnectionResult(val createTime: String, val displayName: String, val error: StatusResponse, val labels: Map<String, String>, val name: String, val state: String, val updateTime: String, val vpcPeeringConfig: VpcPeeringConfigResponse)
Link copied to clipboard
data class MachineConfigResponse(val cpuCount: Int)

MachineConfig describes the configuration of a machine.

Link copied to clipboard
data class MySqlConnectionProfileResponse(val cloudSqlId: String, val host: String, val password: String, val passwordSet: Boolean, val port: Int, val ssl: SslConfigResponse, val username: String)

Specifies connection parameters required specifically for MySQL databases.

Link copied to clipboard
data class OracleConnectionProfileResponse(val databaseService: String, val forwardSshConnectivity: ForwardSshTunnelConnectivityResponse, val host: String, val password: String, val passwordSet: Boolean, val port: Int, val privateConnectivity: PrivateConnectivityResponse, val staticServiceIpConnectivity: StaticServiceIpConnectivityResponse, val username: String)

Specifies connection parameters required specifically for Oracle databases.

Link copied to clipboard
data class PostgreSqlConnectionProfileResponse(val cloudSqlId: String, val host: String, val networkArchitecture: String, val password: String, val passwordSet: Boolean, val port: Int, val privateServiceConnectConnectivity: PrivateServiceConnectConnectivityResponse, val ssl: SslConfigResponse, val staticIpConnectivity: StaticIpConnectivityResponse, val username: String)

Specifies connection parameters required specifically for PostgreSQL databases.

Link copied to clipboard
data class PrimaryInstanceSettingsResponse(val databaseFlags: Map<String, String>, val labels: Map<String, String>, val machineConfig: MachineConfigResponse, val privateIp: String)

Settings for the cluster's primary instance

Link copied to clipboard
data class PrivateConnectivityResponse(val privateConnection: String)

Private Connectivity.

data class PrivateServiceConnectConnectivityResponse(val serviceAttachment: String)

Private Service Connect connectivity (https://cloud.google.com/vpc/docs/private-service-connect#service-attachments)

Link copied to clipboard
data class ReverseSshConnectivityResponse(val vm: String, val vmIp: String, val vmPort: Int, val vpc: String)

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.

Link copied to clipboard
data class SqlAclEntryResponse(val expireTime: String, val label: String, val ttl: String, val value: String)

An entry for an Access Control list.

Link copied to clipboard
data class SqlIpConfigResponse(val allocatedIpRange: String, val authorizedNetworks: List<SqlAclEntryResponse>, val enableIpv4: Boolean, val privateNetwork: String, val requireSsl: Boolean)

IP Management configuration.

Link copied to clipboard
data class SslConfigResponse(val caCertificate: String, val clientCertificate: String, val clientKey: String, val type: String)

SSL configuration information.

Link copied to clipboard

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.

Link copied to clipboard

Static IP address connectivity configured on service project.

Link copied to clipboard
data class StatusResponse(val code: Int, val details: List<Map<String, String>>, val message: String)

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.

Link copied to clipboard
data class UserPasswordResponse(val password: String, val passwordSet: Boolean, val user: String)

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

Link copied to clipboard
data class VpcPeeringConfigResponse(val subnet: String, val vpcName: String)

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

Link copied to clipboard

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.