Package-level declarations

Types

Link copied to clipboard
data class AclEntryResponse(val expirationTime: String, val kind: String, val name: String, val value: String)

An entry for an Access Control list.

Link copied to clipboard
data class AdvancedMachineFeaturesResponse(val threadsPerCore: Int)

Specifies options for controlling advanced machine features.

Link copied to clipboard
data class BackupConfigurationResponse(val backupRetentionSettings: BackupRetentionSettingsResponse, val binaryLogEnabled: Boolean, val enabled: Boolean, val kind: String, val location: String, val pointInTimeRecoveryEnabled: Boolean, val replicationLogArchivingEnabled: Boolean, val startTime: String, val transactionLogRetentionDays: Int)

Database instance backup configuration.

Link copied to clipboard
data class BackupRetentionSettingsResponse(val retainedBackups: Int, val retentionUnit: String)

We currently only support backup retention by specifying the number of backups we will retain.

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

Database flags for Cloud SQL instances.

Link copied to clipboard
data class DenyMaintenancePeriodResponse(val endDate: String, val startDate: String, val time: String)

Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

Link copied to clipboard
data class DiskEncryptionConfigurationResponse(val kind: String, val kmsKeyName: String)

Disk encryption configuration for an instance.

Link copied to clipboard
data class DiskEncryptionStatusResponse(val kind: String, val kmsKeyVersionName: String)

Disk encryption status for an instance.

Link copied to clipboard
data class GetBackupRunResult(val backupKind: String, val description: String, val diskEncryptionConfiguration: DiskEncryptionConfigurationResponse, val diskEncryptionStatus: DiskEncryptionStatusResponse, val endTime: String, val enqueuedTime: String, val error: OperationErrorResponse, val instance: String, val kind: String, val location: String, val selfLink: String, val startTime: String, val status: String, val timeZone: String, val type: String, val windowStartTime: String)
Link copied to clipboard
data class GetDatabaseResult(val charset: String, val collation: String, val etag: String, val instance: String, val kind: String, val name: String, val project: String, val selfLink: String, val sqlserverDatabaseDetails: SqlServerDatabaseDetailsResponse)
Link copied to clipboard
data class GetInstanceResult(val availableMaintenanceVersions: List<String>, val backendType: String, val connectionName: String, val createTime: String, val currentDiskSize: String, val databaseInstalledVersion: String, val databaseVersion: String, val diskEncryptionConfiguration: DiskEncryptionConfigurationResponse, val diskEncryptionStatus: DiskEncryptionStatusResponse, val etag: String, val failoverReplica: InstanceFailoverReplicaResponse, val gceZone: String, val instanceType: String, val ipAddresses: List<IpMappingResponse>, val ipv6Address: String, val kind: String, val maintenanceVersion: String, val masterInstanceName: String, val maxDiskSize: String, val name: String, val onPremisesConfiguration: OnPremisesConfigurationResponse, val outOfDiskReport: SqlOutOfDiskReportResponse, val project: String, val region: String, val replicaConfiguration: ReplicaConfigurationResponse, val replicaNames: List<String>, val rootPassword: String, val satisfiesPzs: Boolean, val scheduledMaintenance: SqlScheduledMaintenanceResponse, val secondaryGceZone: String, val selfLink: String, val serverCaCert: SslCertResponse, val serviceAccountEmailAddress: String, val settings: SettingsResponse, val state: String, val suspensionReason: List<String>)
Link copied to clipboard
data class GetSslCertResult(val cert: String, val certSerialNumber: String, val commonName: String, val createTime: String, val expirationTime: String, val instance: String, val kind: String, val selfLink: String, val sha1Fingerprint: String)
Link copied to clipboard
data class GetUserResult(val dualPasswordType: String, val etag: String, val host: String, val instance: String, val kind: String, val name: String, val password: String, val passwordPolicy: UserPasswordValidationPolicyResponse, val project: String, val sqlserverUserDetails: SqlServerUserDetailsResponse, val type: String)
Link copied to clipboard
data class InsightsConfigResponse(val queryInsightsEnabled: Boolean, val queryPlansPerMinute: Int, val queryStringLength: Int, val recordApplicationTags: Boolean, val recordClientAddress: Boolean)

Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration.

Link copied to clipboard
data class InstanceFailoverReplicaResponse(val available: Boolean, val name: String)

The name and status of the failover replica.

Link copied to clipboard
data class InstanceReferenceResponse(val name: String, val project: String, val region: String)

Reference to another Cloud SQL instance.

Link copied to clipboard
data class IpConfigurationResponse(val allocatedIpRange: String, val authorizedNetworks: List<AclEntryResponse>, val enablePrivatePathForGoogleCloudServices: Boolean, val ipv4Enabled: Boolean, val privateNetwork: String, val requireSsl: Boolean)

IP Management configuration.

Link copied to clipboard
data class IpMappingResponse(val ipAddress: String, val timeToRetire: String, val type: String)

Database instance IP Mapping.

Link copied to clipboard
data class LocationPreferenceResponse(val followGaeApplication: String, val kind: String, val secondaryZone: String, val zone: String)

Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified.

Link copied to clipboard
data class MaintenanceWindowResponse(val day: Int, val hour: Int, val kind: String, val updateTrack: String)

Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes.

Link copied to clipboard
data class MySqlReplicaConfigurationResponse(val caCertificate: String, val clientCertificate: String, val clientKey: String, val connectRetryInterval: Int, val dumpFilePath: String, val kind: String, val masterHeartbeatPeriod: String, val password: String, val sslCipher: String, val username: String, val verifyServerCertificate: Boolean)

Read-replica configuration specific to MySQL databases.

Link copied to clipboard
data class OnPremisesConfigurationResponse(val caCertificate: String, val clientCertificate: String, val clientKey: String, val dumpFilePath: String, val hostPort: String, val kind: String, val password: String, val sourceInstance: InstanceReferenceResponse, val username: String)

On-premises instance configuration.

Link copied to clipboard
data class OperationErrorResponse(val code: String, val kind: String, val message: String)

Database instance operation error.

Link copied to clipboard
data class PasswordStatusResponse(val locked: Boolean, val passwordExpirationTime: String)

Read-only password status.

Link copied to clipboard
data class PasswordValidationPolicyResponse(val complexity: String, val disallowUsernameSubstring: Boolean, val enablePasswordPolicy: Boolean, val minLength: Int, val passwordChangeInterval: String, val reuseInterval: Int)

Database instance local user password validation policy

Link copied to clipboard
data class ReplicaConfigurationResponse(val failoverTarget: Boolean, val kind: String, val mysqlReplicaConfiguration: MySqlReplicaConfigurationResponse)

Read-replica configuration for connecting to the primary instance.

Link copied to clipboard
data class SettingsResponse(val activationPolicy: String, val activeDirectoryConfig: SqlActiveDirectoryConfigResponse, val advancedMachineFeatures: AdvancedMachineFeaturesResponse, val authorizedGaeApplications: List<String>, val availabilityType: String, val backupConfiguration: BackupConfigurationResponse, val collation: String, val connectorEnforcement: String, val crashSafeReplicationEnabled: Boolean, val dataDiskSizeGb: String, val dataDiskType: String, val databaseFlags: List<DatabaseFlagsResponse>, val databaseReplicationEnabled: Boolean, val deletionProtectionEnabled: Boolean, val denyMaintenancePeriods: List<DenyMaintenancePeriodResponse>, val insightsConfig: InsightsConfigResponse, val ipConfiguration: IpConfigurationResponse, val kind: String, val locationPreference: LocationPreferenceResponse, val maintenanceWindow: MaintenanceWindowResponse, val passwordValidationPolicy: PasswordValidationPolicyResponse, val pricingPlan: String, val replicationType: String, val settingsVersion: String, val sqlServerAuditConfig: SqlServerAuditConfigResponse, val storageAutoResize: Boolean, val storageAutoResizeLimit: String, val tier: String, val timeZone: String, val userLabels: Map<String, String>)

Database instance settings.

Link copied to clipboard
data class SqlActiveDirectoryConfigResponse(val domain: String, val kind: String)

Active Directory configuration, relevant only for Cloud SQL for SQL Server.

Link copied to clipboard
data class SqlOutOfDiskReportResponse(val sqlMinRecommendedIncreaseSizeGb: Int, val sqlOutOfDiskState: String)

This message wraps up the information written by out-of-disk detection job.

Link copied to clipboard
data class SqlScheduledMaintenanceResponse(val canDefer: Boolean, val canReschedule: Boolean, val scheduleDeadlineTime: String, val startTime: String)

Any scheduled maintenance for this instance.

Link copied to clipboard
data class SqlServerAuditConfigResponse(val bucket: String, val kind: String, val retentionInterval: String, val uploadInterval: String)

SQL Server specific audit configuration.

Link copied to clipboard
data class SqlServerDatabaseDetailsResponse(val compatibilityLevel: Int, val recoveryModel: String)

Represents a Sql Server database on the Cloud SQL instance.

Link copied to clipboard
data class SqlServerUserDetailsResponse(val disabled: Boolean, val serverRoles: List<String>)

Represents a Sql Server user on the Cloud SQL instance.

Link copied to clipboard
data class SslCertResponse(val cert: String, val certSerialNumber: String, val commonName: String, val createTime: String, val expirationTime: String, val instance: String, val kind: String, val selfLink: String, val sha1Fingerprint: String)

SslCerts Resource

Link copied to clipboard
data class UserPasswordValidationPolicyResponse(val allowedFailedAttempts: Int, val enableFailedAttemptsCheck: Boolean, val enablePasswordVerification: Boolean, val passwordExpirationDuration: String, val status: PasswordStatusResponse)

User level password validation policy.