Types overview

AclEntry

An entry for an Access Control list.
Fields
expirationTime

string (Timestamp format)

The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

kind

string

This is always sql#aclEntry.

name

string

Optional. A label to identify this entry.

value

string

The allowlisted value for the access control list.

ApiWarning

An Admin API warning message.
Fields
code

enum

Code to uniquely identify the warning type.

Enum type. Can be one of the following:
SQL_API_WARNING_CODE_UNSPECIFIED An unknown or unset warning type from Cloud SQL API.
REGION_UNREACHABLE Warning when one or more regions are not reachable. The returned result set may be incomplete.
message

string

The warning message.

region

string

The region name for REGION_UNREACHABLE warning.

BackupConfiguration

Database instance backup configuration.
Fields
backupRetentionSettings

object (BackupRetentionSettings)

Backup retention settings.

binaryLogEnabled

boolean

(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

enabled

boolean

Whether this configuration is enabled.

kind

string

This is always sql#backupConfiguration.

location

string

Location of the backup

pointInTimeRecoveryEnabled

boolean

(Postgres only) Whether point in time recovery is enabled.

replicationLogArchivingEnabled

boolean

Reserved for future use.

startTime

string

Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.

transactionLogRetentionDays

integer (int32 format)

The number of days of transaction logs we retain for point in time restore, from 1-7.

BackupContext

Backup context.
Fields
backupId

string (int64 format)

The identifier of the backup.

kind

string

This is always sql#backupContext.

BackupRetentionSettings

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

integer (int32 format)

Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.

retentionUnit

enum

The unit that 'retained_backups' represents.

Enum type. Can be one of the following:
RETENTION_UNIT_UNSPECIFIED Backup retention unit is unspecified, will be treated as COUNT.
COUNT Retention will be by count, eg. "retain the most recent 7 backups".

BackupRun

A BackupRun resource.
Fields
backupKind

enum

Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.

Enum type. Can be one of the following:
SQL_BACKUP_KIND_UNSPECIFIED This is an unknown BackupKind.
SNAPSHOT The snapshot based backups
PHYSICAL Physical backups
description

string

The description of this run, only applicable to on-demand backups.

diskEncryptionConfiguration

object (DiskEncryptionConfiguration)

Encryption configuration specific to a backup.

diskEncryptionStatus

object (DiskEncryptionStatus)

Encryption status specific to a backup.

endTime

string (Timestamp format)

The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

enqueuedTime

string (Timestamp format)

The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

error

object (OperationError)

Information about why the backup operation failed. This is only present if the run has the FAILED status.

id

string (int64 format)

The identifier for this backup run. Unique only for a specific Cloud SQL instance.

instance

string

Name of the database instance.

kind

string

This is always sql#backupRun.

location

string

Location of the backups.

selfLink

string

The URI of this resource.

startTime

string (Timestamp format)

The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

status

enum

The status of this run.

Enum type. Can be one of the following:
SQL_BACKUP_RUN_STATUS_UNSPECIFIED The status of the run is unknown.
ENQUEUED The backup operation was enqueued.
OVERDUE The backup is overdue across a given backup window. Indicates a problem. Example: Long-running operation in progress during the whole window.
RUNNING The backup is in progress.
FAILED The backup failed.
SUCCESSFUL The backup was successful.
SKIPPED The backup was skipped (without problems) for a given backup window. Example: Instance was idle.
DELETION_PENDING The backup is about to be deleted.
DELETION_FAILED The backup deletion failed.
DELETED The backup has been deleted.
type

enum

The type of this run; can be either "AUTOMATED" or "ON_DEMAND". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.

Enum type. Can be one of the following:
SQL_BACKUP_RUN_TYPE_UNSPECIFIED This is an unknown BackupRun type.
AUTOMATED The backup schedule automatically triggers a backup.
ON_DEMAND The user manually triggers a backup.
windowStartTime

string (Timestamp format)

The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

BackupRunsListResponse

Backup run list results.
Fields
items[]

object (BackupRun)

A list of backup runs in reverse chronological order of the enqueued time.

kind

string

This is always sql#backupRunsList.

nextPageToken

string

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

BinLogCoordinates

Binary log coordinates.
Fields
binLogFileName

string

Name of the binary log file for a Cloud SQL instance.

binLogPosition

string (int64 format)

Position (offset) within the binary log file.

kind

string

This is always sql#binLogCoordinates.

CloneContext

Database instance clone context.
Fields
binLogCoordinates

object (BinLogCoordinates)

Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.

destinationInstanceName

string

Name of the Cloud SQL instance to be created as a clone.

kind

string

This is always sql#cloneContext.

pitrTimestampMs

string (int64 format)

Reserved for future use.

pointInTime

string (Timestamp format)

Timestamp, if specified, identifies the time to which the source instance is cloned.

ConnectSettings

Connect settings retrieval response.
Fields
backendType

enum

SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.

Enum type. Can be one of the following:
SQL_BACKEND_TYPE_UNSPECIFIED This is an unknown backend type for instance.
FIRST_GEN V1 speckle instance.
SECOND_GEN V2 speckle instance.
EXTERNAL On premises instance.
databaseVersion

enum

The database engine type and version. The databaseVersion field cannot be changed after instance creation. MySQL instances: MYSQL_8_0, MYSQL_5_7 (default), or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11 or POSTGRES_12 (default). SQL Server instances: SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, or SQLSERVER_2017_WEB.

Enum type. Can be one of the following:
SQL_DATABASE_VERSION_UNSPECIFIED This is an unknown database version.
MYSQL_5_1 The database version is MySQL 5.1.
MYSQL_5_5 The database version is MySQL 5.5.
MYSQL_5_6 The database version is MySQL 5.6.
MYSQL_5_7 The database version is MySQL 5.7.
POSTGRES_9_6 The database version is PostgreSQL 9.6.
POSTGRES_11 The database version is PostgreSQL 11.
SQLSERVER_2017_STANDARD The database version is SQL Server 2017 Standard.
SQLSERVER_2017_ENTERPRISE The database version is SQL Server 2017 Enterprise.
SQLSERVER_2017_EXPRESS The database version is SQL Server 2017 Express.
SQLSERVER_2017_WEB The database version is SQL Server 2017 Web.
POSTGRES_10 The database version is PostgreSQL 10.
POSTGRES_12 The database version is PostgreSQL 12.
POSTGRES_13 The database version is PostgreSQL 13.
SQLSERVER_2019_STANDARD The database version is SQL Server 2019 Standard.
SQLSERVER_2019_ENTERPRISE The database version is SQL Server 2019 Enterprise.
SQLSERVER_2019_EXPRESS The database version is SQL Server 2019 Express.
SQLSERVER_2019_WEB The database version is SQL Server 2019 Web.
ipAddresses[]

object (IpMapping)

The assigned IP addresses for the instance.

kind

string

This is always sql#connectSettings.

serverCaCert

object (SslCert)

SSL configuration.

Database

Represents a SQL database on the Cloud SQL instance.
Fields
charset

string

The Cloud SQL charset value.

collation

string

The Cloud SQL collation value.

etag

string

This field is deprecated and will be removed from a future version of the API.

instance

string

The name of the Cloud SQL instance. This does not include the project ID.

kind

string

This is always sql#database.

name

string

The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.

project

string

The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.

selfLink

string

The URI of this resource.

sqlserverDatabaseDetails

object (SqlServerDatabaseDetails)

(No description provided)

DatabaseFlags

Database flags for Cloud SQL instances.
Fields
name

string

The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.

value

string

The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.

DatabaseInstance

A Cloud SQL instance resource.
Fields
backendType

enum

SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.

Enum type. Can be one of the following:
SQL_BACKEND_TYPE_UNSPECIFIED This is an unknown backend type for instance.
FIRST_GEN V1 speckle instance.
SECOND_GEN V2 speckle instance.
EXTERNAL On premises instance.
connectionName

string

Connection name of the Cloud SQL instance used in connection strings.

createTime

string (Timestamp format)

Output only. The time when the instance was created in RFC 3339 format (https://tools.ietf.org/html/rfc3339), for example 2012-11-15T16:19:00.094Z

currentDiskSize

string (int64 format)

The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

databaseVersion

enum

The database engine type and version. The databaseVersion field cannot be changed after instance creation. MySQL instances: MYSQL_8_0, MYSQL_5_7 (default), or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13 (default). SQL Server instances: SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB, SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, or SQLSERVER_2017_WEB.

Enum type. Can be one of the following:
SQL_DATABASE_VERSION_UNSPECIFIED This is an unknown database version.
MYSQL_5_1 The database version is MySQL 5.1.
MYSQL_5_5 The database version is MySQL 5.5.
MYSQL_5_6 The database version is MySQL 5.6.
MYSQL_5_7 The database version is MySQL 5.7.
POSTGRES_9_6 The database version is PostgreSQL 9.6.
POSTGRES_11 The database version is PostgreSQL 11.
SQLSERVER_2017_STANDARD The database version is SQL Server 2017 Standard.
SQLSERVER_2017_ENTERPRISE The database version is SQL Server 2017 Enterprise.
SQLSERVER_2017_EXPRESS The database version is SQL Server 2017 Express.
SQLSERVER_2017_WEB The database version is SQL Server 2017 Web.
POSTGRES_10 The database version is PostgreSQL 10.
POSTGRES_12 The database version is PostgreSQL 12.
POSTGRES_13 The database version is PostgreSQL 13.
SQLSERVER_2019_STANDARD The database version is SQL Server 2019 Standard.
SQLSERVER_2019_ENTERPRISE The database version is SQL Server 2019 Enterprise.
SQLSERVER_2019_EXPRESS The database version is SQL Server 2019 Express.
SQLSERVER_2019_WEB The database version is SQL Server 2019 Web.
diskEncryptionConfiguration

object (DiskEncryptionConfiguration)

Disk encryption configuration specific to an instance.

diskEncryptionStatus

object (DiskEncryptionStatus)

Disk encryption status specific to an instance.

etag

string

This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.

failoverReplica

object

The name and status of the failover replica.

failoverReplica.available

boolean

The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.

failoverReplica.name

string

The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID.

gceZone

string

The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.

instanceType

enum

The instance type. This can be one of the following. CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a primary instance. ON_PREMISES_INSTANCE: An instance running on the customer's premises. READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.

Enum type. Can be one of the following:
SQL_INSTANCE_TYPE_UNSPECIFIED This is an unknown Cloud SQL instance type.
CLOUD_SQL_INSTANCE A regular Cloud SQL instance.
ON_PREMISES_INSTANCE An instance running on the customer's premises that is not managed by Cloud SQL.
READ_REPLICA_INSTANCE A Cloud SQL instance acting as a read-replica.
ipAddresses[]

object (IpMapping)

The assigned IP addresses for the instance.

ipv6Address

string

The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

kind

string

This is always sql#instance.

masterInstanceName

string

The name of the instance which will act as primary in the replication setup.

maxDiskSize

string (int64 format)

The maximum disk size of the instance in bytes.

name

string

Name of the Cloud SQL instance. This does not include the project ID.

onPremisesConfiguration

object (OnPremisesConfiguration)

Configuration specific to on-premises instances.

outOfDiskReport

object (SqlOutOfDiskReport)

This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job

project

string

The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

region

string

The geographical region. Can be us-central (FIRST_GEN instances only) us-central1 (SECOND_GEN instances only) asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type. The region cannot be changed after instance creation.

replicaConfiguration

object (ReplicaConfiguration)

Configuration specific to failover replicas and read replicas.

replicaNames[]

string

The replicas of the instance.

rootPassword

string

Initial root password. Use only on creation.

satisfiesPzs

boolean

The status indicating if instance satisfiesPzs. Reserved for future use.

scheduledMaintenance

object (SqlScheduledMaintenance)

The start time of any upcoming scheduled maintenance for this instance.

secondaryGceZone

string

The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.

selfLink

string

The URI of this resource.

serverCaCert

object (SslCert)

SSL configuration.

serviceAccountEmailAddress

string

The service account email address assigned to the instance. This property is read-only.

settings

object (Settings)

The user settings.

state

enum

The current serving state of the Cloud SQL instance. This can be one of the following. SQL_INSTANCE_STATE_UNSPECIFIED: The state of the instance is unknown. RUNNABLE: The instance is running, or has been stopped by owner. SUSPENDED: The instance is not available, for example due to problems with billing. PENDING_DELETE: The instance is being deleted. PENDING_CREATE: The instance is being created. MAINTENANCE: The instance is down for maintenance. FAILED: The instance creation failed.

Enum type. Can be one of the following:
SQL_INSTANCE_STATE_UNSPECIFIED The state of the instance is unknown.
RUNNABLE The instance is running, or has been stopped by owner.
SUSPENDED The instance is not available, for example due to problems with billing.
PENDING_DELETE The instance is being deleted.
PENDING_CREATE The instance is being created.
MAINTENANCE The instance is down for maintenance.
FAILED The creation of the instance failed or a fatal error occurred during maintenance.
ONLINE_MAINTENANCE The instance is under maintenance operations and the database is available.
suspensionReason[]

string

If the instance state is SUSPENDED, the reason for the suspension.

DatabasesListResponse

Database list response.
Fields
items[]

object (Database)

List of database resources in the instance.

kind

string

This is always sql#databasesList.

DemoteMasterConfiguration

Read-replica configuration for connecting to the on-premises primary instance.
Fields
kind

string

This is always sql#demoteMasterConfiguration.

mysqlReplicaConfiguration

object (DemoteMasterMySqlReplicaConfiguration)

MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.

DemoteMasterContext

Database instance demote primary instance context.
Fields
kind

string

This is always sql#demoteMasterContext.

masterInstanceName

string

The name of the instance which will act as on-premises primary instance in the replication setup.

replicaConfiguration

object (DemoteMasterConfiguration)

Configuration specific to read-replicas replicating from the on-premises primary instance.

skipReplicationSetup

boolean

Flag to skip replication setup on the instance.

verifyGtidConsistency

boolean

Verify GTID consistency for demote operation. Default value: True. Setting this flag to false enables you to bypass GTID consistency check between on-premises primary instance and Cloud SQL instance during the demotion operation but also exposes you to the risk of future replication failures. Change the value value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues.

DemoteMasterMySqlReplicaConfiguration

Read-replica configuration specific to MySQL databases.
Fields
caCertificate

string

PEM representation of the trusted CA's x509 certificate.

clientCertificate

string

PEM representation of the replica's x509 certificate.

clientKey

string

PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8.

kind

string

This is always sql#demoteMasterMysqlReplicaConfiguration.

password

string

The password for the replication connection.

username

string

The username for the replication connection.

DenyMaintenancePeriod

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

string

"deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

startDate

string

"deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01

time

string

Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00

DiskEncryptionConfiguration

Disk encryption configuration for an instance.
Fields
kind

string

This is always sql#diskEncryptionConfiguration.

kmsKeyName

string

Resource name of KMS key for disk encryption

DiskEncryptionStatus

Disk encryption status for an instance.
Fields
kind

string

This is always sql#diskEncryptionStatus.

kmsKeyVersionName

string

KMS key version used to encrypt the Cloud SQL instance resource

ExportContext

Database instance export context.
Fields
csvExportOptions

object

Options for exporting data as CSV. MySQL and PostgreSQL instances only.

csvExportOptions.selectQuery

string

The select query used to extract the data.

databases[]

string

Databases to be exported. MySQL instances: If fileType is SQL and no database is specified, all databases are exported, except for the mysql system database. If fileType is CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQuery property, which takes precedence over this property. PostgreSQL instances: You must specify one database to be exported. If fileType is CSV, this database must match the one specified in the csvExportOptions.selectQuery property. SQL Server instances: You must specify one database to be exported, and the fileType must be BAK.

fileType

enum

The file type for the specified uri. SQL: The file contains SQL statements. CSV: The file contains CSV data. BAK: The file contains backup data for a SQL Server instance.

Enum type. Can be one of the following:
SQL_FILE_TYPE_UNSPECIFIED Unknown file type.
SQL File containing SQL statements.
CSV File in CSV format.
BAK (No description provided)
kind

string

This is always sql#exportContext.

offload

boolean

Option for export offload.

sqlExportOptions

object

Options for exporting data as SQL statements.

sqlExportOptions.mysqlExportOptions

object

Options for exporting from MySQL.

sqlExportOptions.mysqlExportOptions.masterData

integer (int32 format)

Option to include SQL statement required to set up replication. If set to 1, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to 2, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than 1, --set-gtid-purged is set to OFF.

sqlExportOptions.schemaOnly

boolean

Export only schemas.

sqlExportOptions.tables[]

string

Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

uri

string

The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the request succeeds, but the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.

FailoverContext

Database instance failover context.
Fields
kind

string

This is always sql#failoverContext.

settingsVersion

string (int64 format)

The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version.

Flag

A flag resource.
Fields
allowedIntValues[]

string (int64 format)

Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.

allowedStringValues[]

string

For STRING flags, a list of strings that the value can be set to.

appliesTo[]

string

The database version this flag applies to. Can be MYSQL_8_0, MYSQL_5_6, or MYSQL_5_7.

inBeta

boolean

Whether or not the flag is considered in beta.

kind

string

This is always sql#flag.

maxValue

string (int64 format)

For INTEGER flags, the maximum allowed value.

minValue

string (int64 format)

For INTEGER flags, the minimum allowed value.

name

string

This is the name of the flag. Flag names always use underscores, not hyphens, for example: max_allowed_packet

requiresRestart

boolean

Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.

type

enum

The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags which do not take a value, such as skip_grant_tables.

Enum type. Can be one of the following:
SQL_FLAG_TYPE_UNSPECIFIED This is an unknown flag type.
BOOLEAN Boolean type flag.
STRING String type flag.
INTEGER Integer type flag.
NONE Flag type used for a server startup option.
MYSQL_TIMEZONE_OFFSET Type introduced specially for MySQL TimeZone offset. Accept a string value with the format [-12:59, 13:00].
FLOAT Float type flag.
REPEATED_STRING Comma-separated list of the strings in a SqlFlagType enum.

FlagsListResponse

Flags list response.
Fields
items[]

object (Flag)

List of flags.

kind

string

This is always sql#flagsList.

GenerateEphemeralCertRequest

Ephemeral certificate creation request.
Fields
access_token

string

Optional. Access token to include in the signed certificate.

public_key

string

PEM encoded public key to include in the signed certificate.

readTime

string (Timestamp format)

Optional. Optional snapshot read timestamp to trade freshness for performance.

GenerateEphemeralCertResponse

Ephemeral certificate creation request.
Fields
ephemeralCert

object (SslCert)

Generated cert

ImportContext

Database instance import context.
Fields
bakImportOptions

object

Import parameters specific to SQL Server .BAK files

bakImportOptions.encryptionOptions

object

(No description provided)

bakImportOptions.encryptionOptions.certPath

string

Path to the Certificate (.cer) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

bakImportOptions.encryptionOptions.pvkPassword

string

Password that encrypts the private key

bakImportOptions.encryptionOptions.pvkPath

string

Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

csvImportOptions

object

Options for importing data as CSV.

csvImportOptions.columns[]

string

The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

csvImportOptions.table

string

The table to which CSV data is imported.

database

string

The target database for the import. If fileType is SQL, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If fileType is CSV, one database must be specified.

fileType

enum

The file type for the specified uri. SQL: The file contains SQL statements. CSV: The file contains CSV data.

Enum type. Can be one of the following:
SQL_FILE_TYPE_UNSPECIFIED Unknown file type.
SQL File containing SQL statements.
CSV File in CSV format.
BAK (No description provided)
importUser

string

The PostgreSQL user for this import operation. PostgreSQL instances only.

kind

string

This is always sql#importContext.

uri

string

Path to the import file in Cloud Storage, in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL. The instance must have write permissions to the bucket and read access to the file.

InsightsConfig

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

boolean

Whether Query Insights feature is enabled.

queryPlansPerMinute

integer (int32 format)

Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.

queryStringLength

integer (int32 format)

Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.

recordApplicationTags

boolean

Whether Query Insights will record application tags from query when enabled.

recordClientAddress

boolean

Whether Query Insights will record client address when enabled.

InstanceReference

Reference to another Cloud SQL instance.
Fields
name

string

The name of the Cloud SQL instance being referenced. This does not include the project ID.

project

string

The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it.

region

string

The region of the Cloud SQL instance being referenced.

InstancesCloneRequest

Database instance clone request.
Fields
cloneContext

object (CloneContext)

Contains details about the clone operation.

InstancesDemoteMasterRequest

Database demote primary instance request.
Fields
demoteMasterContext

object (DemoteMasterContext)

Contains details about the demoteMaster operation.

InstancesExportRequest

Database instance export request.
Fields
exportContext

object (ExportContext)

Contains details about the export operation.

exportContext.csvExportOptions.selectQuery

string

The select query used to extract the data.

exportContext.sqlExportOptions.mysqlExportOptions

object

Options for exporting from MySQL.

exportContext.sqlExportOptions.mysqlExportOptions.masterData

integer (int32 format)

Option to include SQL statement required to set up replication. If set to 1, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to 2, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than 1, --set-gtid-purged is set to OFF.

exportContext.sqlExportOptions.schemaOnly

boolean

Export only schemas.

exportContext.sqlExportOptions.tables[]

string

Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

InstancesFailoverRequest

Instance failover request.
Fields
failoverContext

object (FailoverContext)

Failover Context.

InstancesImportRequest

Database instance import request.
Fields
importContext

object (ImportContext)

Contains details about the import operation.

importContext.bakImportOptions.encryptionOptions

object

(No description provided)

importContext.bakImportOptions.encryptionOptions.certPath

string

Path to the Certificate (.cer) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

importContext.bakImportOptions.encryptionOptions.pvkPassword

string

Password that encrypts the private key

importContext.bakImportOptions.encryptionOptions.pvkPath

string

Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

importContext.csvImportOptions.columns[]

string

The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

importContext.csvImportOptions.table

string

The table to which CSV data is imported.

InstancesListResponse

Database instances list response.
Fields
items[]

object (DatabaseInstance)

List of database instance resources.

kind

string

This is always sql#instancesList.

nextPageToken

string

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

warnings[]

object (ApiWarning)

List of warnings that occurred while handling the request.

InstancesListServerCasResponse

Instances ListServerCas response.
Fields
activeVersion

string

(No description provided)

certs[]

object (SslCert)

List of server CA certificates for the instance.

kind

string

This is always sql#instancesListServerCas.

InstancesRestoreBackupRequest

Database instance restore backup request.
Fields
restoreBackupContext

object (RestoreBackupContext)

Parameters required to perform the restore backup operation.

InstancesRotateServerCaRequest

Rotate server CA request.
Fields
rotateServerCaContext

object (RotateServerCaContext)

Contains details about the rotate server CA operation.

InstancesTruncateLogRequest

Instance truncate log request.
Fields
truncateLogContext

object (TruncateLogContext)

Contains details about the truncate log operation.

IpConfiguration

IP Management configuration.
Fields
allocatedIpRange

string

The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. Reserved for future use.

authorizedNetworks[]

object (AclEntry)

The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: 192.168.100.0/24).

ipv4Enabled

boolean

Whether the instance is assigned a public IP address or not.

privateNetwork

string

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.

requireSsl

boolean

Whether SSL connections over IP are enforced or not.

IpMapping

Database instance IP Mapping.
Fields
ipAddress

string

The IP address assigned.

timeToRetire

string (Timestamp format)

The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.

type

enum

The type of this IP address. A PRIMARY address is a public address that can accept incoming connections. A PRIVATE address is a private address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported.

Enum type. Can be one of the following:
SQL_IP_ADDRESS_TYPE_UNSPECIFIED This is an unknown IP address type.
PRIMARY IP address the customer is supposed to connect to. Usually this is the load balancer's IP address
OUTGOING Source IP address of the connection a read replica establishes to its external primary instance. This IP address can be allowlisted by the customer in case it has a firewall that filters incoming connection to its on premises primary instance.
PRIVATE Private IP used when using private IPs and network peering.
MIGRATED_1ST_GEN V1 IP of a migrated instance. We want the user to decommission this IP as soon as the migration is complete. Note: V1 instances with V1 ip addresses will be counted as PRIMARY.

LocationPreference

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.
Fields
followGaeApplication

string

The App Engine application to follow, it must be in the same region as the Cloud SQL instance.

kind

string

This is always sql#locationPreference.

secondaryZone

string

The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.

zone

string

The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).

MaintenanceWindow

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

integer (int32 format)

day of week (1-7), starting on Monday.

hour

integer (int32 format)

hour of day - 0 to 23.

kind

string

This is always sql#maintenanceWindow.

updateTrack

enum

Maintenance timing setting: canary (Earlier) or stable (Later). Learn more.

Enum type. Can be one of the following:
SQL_UPDATE_TRACK_UNSPECIFIED This is an unknown maintenance timing preference.
canary For instance update that requires a restart, this update track indicates your instance prefer to restart for new version early in maintenance window.
stable For instance update that requires a restart, this update track indicates your instance prefer to let Cloud SQL choose the timing of restart (within its Maintenance window, if applicable).

MySqlReplicaConfiguration

Read-replica configuration specific to MySQL databases.
Fields
caCertificate

string

PEM representation of the trusted CA's x509 certificate.

clientCertificate

string

PEM representation of the replica's x509 certificate.

clientKey

string

PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

connectRetryInterval

integer (int32 format)

Seconds to wait between connect retries. MySQL's default is 60 seconds.

dumpFilePath

string

Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump.

kind

string

This is always sql#mysqlReplicaConfiguration.

masterHeartbeatPeriod

string (int64 format)

Interval in milliseconds between replication heartbeats.

password

string

The password for the replication connection.

sslCipher

string

A list of permissible ciphers to use for SSL encryption.

username

string

The username for the replication connection.

verifyServerCertificate

boolean

Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.

MySqlSyncConfig

MySQL-specific external server sync settings.
Fields
initialSyncFlags[]

object (SyncFlags)

Flags to use for the initial dump.

OnPremisesConfiguration

On-premises instance configuration.
Fields
caCertificate

string

PEM representation of the trusted CA's x509 certificate.

clientCertificate

string

PEM representation of the replica's x509 certificate.

clientKey

string

PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

dumpFilePath

string

The dump file to create the Cloud SQL replica.

hostPort

string

The host and port of the on-premises instance in host:port format

kind

string

This is always sql#onPremisesConfiguration.

password

string

The password for connecting to on-premises instance.

sourceInstance

object (InstanceReference)

The reference to Cloud SQL instance if the source is Cloud SQL.

username

string

The username for connecting to on-premises instance.

Operation

An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
Fields
backupContext

object (BackupContext)

The context for backup operation, if applicable.

endTime

string (Timestamp format)

The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

error

object (OperationErrors)

If errors occurred during processing of this operation, this field will be populated.

exportContext

object (ExportContext)

The context for export operation, if applicable.

exportContext.csvExportOptions.selectQuery

string

The select query used to extract the data.

exportContext.sqlExportOptions.mysqlExportOptions

object

Options for exporting from MySQL.

exportContext.sqlExportOptions.mysqlExportOptions.masterData

integer (int32 format)

Option to include SQL statement required to set up replication. If set to 1, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to 2, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than 1, --set-gtid-purged is set to OFF.

exportContext.sqlExportOptions.schemaOnly

boolean

Export only schemas.

exportContext.sqlExportOptions.tables[]

string

Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

importContext

object (ImportContext)

The context for import operation, if applicable.

importContext.bakImportOptions.encryptionOptions

object

(No description provided)

importContext.bakImportOptions.encryptionOptions.certPath

string

Path to the Certificate (.cer) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

importContext.bakImportOptions.encryptionOptions.pvkPassword

string

Password that encrypts the private key

importContext.bakImportOptions.encryptionOptions.pvkPath

string

Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

importContext.csvImportOptions.columns[]

string

The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

importContext.csvImportOptions.table

string

The table to which CSV data is imported.

insertTime

string (Timestamp format)

The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

kind

string

This is always sql#operation.

name

string

An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

operationType

enum

The type of the operation. Valid values are: CREATE DELETE UPDATE RESTART IMPORT EXPORT BACKUP_VOLUME RESTORE_VOLUME CREATE_USER DELETE_USER CREATE_DATABASE DELETE_DATABASE

Enum type. Can be one of the following:
SQL_OPERATION_TYPE_UNSPECIFIED Unknown operation type.
IMPORT Imports data into a Cloud SQL instance.
EXPORT Exports data from a Cloud SQL instance to a Cloud Storage bucket.
CREATE Creates a new Cloud SQL instance.
UPDATE Updates the settings of a Cloud SQL instance.
DELETE Deletes a Cloud SQL instance.
RESTART Restarts the Cloud SQL instance.
BACKUP (No description provided)
SNAPSHOT (No description provided)
BACKUP_VOLUME Performs instance backup.
DELETE_VOLUME Deletes an instance backup.
RESTORE_VOLUME Restores an instance backup.
INJECT_USER Injects a privileged user in mysql for MOB instances.
CLONE Clones a Cloud SQL instance.
STOP_REPLICA Stops replication on a Cloud SQL read replica instance.
START_REPLICA Starts replication on a Cloud SQL read replica instance.
PROMOTE_REPLICA Promotes a Cloud SQL replica instance.
CREATE_REPLICA Creates a Cloud SQL replica instance.
CREATE_USER Creates a new user in a Cloud SQL instance.
DELETE_USER Deletes a user from a Cloud SQL instance.
UPDATE_USER Updates an existing user in a Cloud SQL instance.
CREATE_DATABASE Creates a database in the Cloud SQL instance.
DELETE_DATABASE Deletes a database in the Cloud SQL instance.
UPDATE_DATABASE Updates a database in the Cloud SQL instance.
FAILOVER Performs failover of an HA-enabled Cloud SQL failover replica.
DELETE_BACKUP Deletes the backup taken by a backup run.
RECREATE_REPLICA (No description provided)
TRUNCATE_LOG Truncates a general or slow log table in MySQL.
DEMOTE_MASTER Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.
MAINTENANCE Indicates that the instance is currently in maintenance. Maintenance typically causes the instance to be unavailable for 1-3 minutes.
ENABLE_PRIVATE_IP This field is deprecated, and will be removed in future version of API.
DEFER_MAINTENANCE (No description provided)
CREATE_CLONE Creates clone instance.
RESCHEDULE_MAINTENANCE Reschedule maintenance to another time.
START_EXTERNAL_SYNC Starts external sync of a Cloud SQL EM replica to an external primary instance.
selfLink

string

The URI of this resource.

startTime

string (Timestamp format)

The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

status

enum

The status of an operation. Valid values are: PENDING RUNNING DONE SQL_OPERATION_STATUS_UNSPECIFIED

Enum type. Can be one of the following:
SQL_OPERATION_STATUS_UNSPECIFIED The state of the operation is unknown.
PENDING The operation has been queued, but has not started yet.
RUNNING The operation is running.
DONE The operation completed.
targetId

string

Name of the database instance related to this operation.

targetLink

string

(No description provided)

targetProject

string

The project ID of the target instance related to this operation.

user

string

The email address of the user who initiated this operation.

OperationError

Database instance operation error.
Fields
code

string

Identifies the specific error that occurred.

kind

string

This is always sql#operationError.

message

string

Additional information about the error encountered.

OperationErrors

Database instance operation errors list wrapper.
Fields
errors[]

object (OperationError)

The list of errors encountered while processing this operation.

kind

string

This is always sql#operationErrors.

OperationsListResponse

Operations list response.
Fields
items[]

object (Operation)

List of operation resources.

kind

string

This is always sql#operationsList.

nextPageToken

string

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

ReplicaConfiguration

Read-replica configuration for connecting to the primary instance.
Fields
failoverTarget

boolean

Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

kind

string

This is always sql#replicaConfiguration.

mysqlReplicaConfiguration

object (MySqlReplicaConfiguration)

MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata.The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.

Reschedule

(No description provided)
Fields
rescheduleType

enum

Required. The type of the reschedule.

Enum type. Can be one of the following:
RESCHEDULE_TYPE_UNSPECIFIED (No description provided)
IMMEDIATE Reschedules maintenance to happen now (within 5 minutes).
NEXT_AVAILABLE_WINDOW Reschedules maintenance to occur within one week from the originally scheduled day and time.
SPECIFIC_TIME Reschedules maintenance to a specific time and day.
scheduleTime

string (Timestamp format)

Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

RestoreBackupContext

Database instance restore from backup context. Backup context contains source instance id and project id.
Fields
backupRunId

string (int64 format)

The ID of the backup run to restore from.

instanceId

string

The ID of the instance that the backup was taken from.

kind

string

This is always sql#restoreBackupContext.

project

string

The full project ID of the source instance.

RotateServerCaContext

Instance rotate server CA context.
Fields
kind

string

This is always sql#rotateServerCaContext.

nextVersion

string

The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server CA version.

Settings

Database instance settings.
Fields
activationPolicy

enum

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.

Enum type. Can be one of the following:
SQL_ACTIVATION_POLICY_UNSPECIFIED Unknown activation plan.
ALWAYS The instance is always up and running.
NEVER The instance never starts.
ON_DEMAND The instance starts upon receiving requests.
activeDirectoryConfig

object (SqlActiveDirectoryConfig)

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

authorizedGaeApplications[]

string

The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.

availabilityType

enum

Availability type. Potential values: ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. REGIONAL: The instance can serve data from more than one zone in a region (it is highly available). For more information, see Overview of the High Availability Configuration.

Enum type. Can be one of the following:
SQL_AVAILABILITY_TYPE_UNSPECIFIED This is an unknown Availability type.
ZONAL Zonal available instance.
REGIONAL Regional available instance.
backupConfiguration

object (BackupConfiguration)

The daily backup configuration for the instance.

collation

string

The name of server Instance collation.

crashSafeReplicationEnabled

boolean

Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.

dataDiskSizeGb

string (int64 format)

The size of data disk, in GB. The data disk size minimum is 10GB.

dataDiskType

enum

The type of data disk: PD_SSD (default) or PD_HDD.

Enum type. Can be one of the following:
SQL_DATA_DISK_TYPE_UNSPECIFIED This is an unknown data disk type.
PD_SSD An SSD data disk.
PD_HDD An HDD data disk.
OBSOLETE_LOCAL_SSD This field is deprecated and will be removed from a future version of the API.
databaseFlags[]

object (DatabaseFlags)

The database flags passed to the instance at startup.

databaseReplicationEnabled

boolean

Configuration specific to read replica instances. Indicates whether replication is enabled or not.

denyMaintenancePeriods[]

object (DenyMaintenancePeriod)

Deny maintenance periods

insightsConfig

object (InsightsConfig)

Insights configuration, for now relevant only for Postgres.

ipConfiguration

object (IpConfiguration)

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 for Second Generation instances.

kind

string

This is always sql#settings.

locationPreference

object (LocationPreference)

The location preference settings. This allows the instance to be located as near as possible to Compute Engine zone for better performance.

maintenanceWindow

object (MaintenanceWindow)

The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.

pricingPlan

enum

The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.

Enum type. Can be one of the following:
SQL_PRICING_PLAN_UNSPECIFIED This is an unknown pricing plan for this instance.
PACKAGE The instance is billed at a monthly flat rate.
PER_USE The instance is billed per usage.
replicationType

enum

The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. (Deprecated) This property was only applicable to First Generation instances.

Enum type. Can be one of the following:
SQL_REPLICATION_TYPE_UNSPECIFIED This is an unknown replication type for a Cloud SQL instance.
SYNCHRONOUS The synchronous replication mode for First Generation instances. It is the default value.
ASYNCHRONOUS The asynchronous replication mode for First Generation instances. It provides a slight performance gain, but if an outage occurs while this option is set to asynchronous, you can lose up to a few seconds of updates to your data.
settingsVersion

string (int64 format)

The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.

storageAutoResize

boolean

Configuration to increase storage size automatically. The default value is true.

storageAutoResizeLimit

string (int64 format)

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

tier

string

The tier (or machine type) for this instance, for example db-custom-1-3840.

userLabels

map (key: string, value: string)

User-provided labels, represented as a dictionary where each label is a single key value pair.

SqlActiveDirectoryConfig

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

string

The name of the domain (e.g., mydomain.com).

kind

string

This is always sql#activeDirectoryConfig.

SqlExternalSyncSettingError

External primary instance migration setting error.
Fields
detail

string

Additional information about the error encountered.

kind

string

Can be sql#externalSyncSettingError or sql#externalSyncSettingWarning.

type

enum

Identifies the specific error that occurred.

Enum type. Can be one of the following:
SQL_EXTERNAL_SYNC_SETTING_ERROR_TYPE_UNSPECIFIED (No description provided)
CONNECTION_FAILURE (No description provided)
BINLOG_NOT_ENABLED (No description provided)
INCOMPATIBLE_DATABASE_VERSION (No description provided)
REPLICA_ALREADY_SETUP (No description provided)
INSUFFICIENT_PRIVILEGE (No description provided)
UNSUPPORTED_MIGRATION_TYPE Unsupported migration type.
NO_PGLOGICAL_INSTALLED No pglogical extension installed on databases, applicable for postgres.
PGLOGICAL_NODE_ALREADY_EXISTS pglogical node already exists on databases, applicable for postgres.
INVALID_WAL_LEVEL The value of parameter wal_level is not set to logical.
INVALID_SHARED_PRELOAD_LIBRARY The value of parameter shared_preload_libraries does not include pglogical.
INSUFFICIENT_MAX_REPLICATION_SLOTS The value of parameter max_replication_slots is not sufficient.
INSUFFICIENT_MAX_WAL_SENDERS The value of parameter max_wal_senders is not sufficient.
INSUFFICIENT_MAX_WORKER_PROCESSES The value of parameter max_worker_processes is not sufficient.
UNSUPPORTED_EXTENSIONS Extensions installed are either not supported or having unsupported versions
INVALID_RDS_LOGICAL_REPLICATION The value of parameter rds.logical_replication is not set to 1.
INVALID_LOGGING_SETUP The primary instance logging setup doesn't allow EM sync.
INVALID_DB_PARAM The primary instance database parameter setup doesn't allow EM sync.
UNSUPPORTED_GTID_MODE The gtid_mode is not supported, applicable for MySQL.
SQLSERVER_AGENT_NOT_RUNNING SQL Server Agent is not running.
UNSUPPORTED_TABLE_DEFINITION The table definition is not support due to missing primary key or replica identity, applicable for postgres.
UNSUPPORTED_DEFINER The customer has a definer that will break EM setup.
SQLSERVER_SERVERNAME_MISMATCH SQL Server @@SERVERNAME does not match actual host name
PRIMARY_ALREADY_SETUP The primary instance has been setup and will fail the setup.

SqlInstancesRescheduleMaintenanceRequestBody

Reschedule options for maintenance windows.
Fields
reschedule

object (Reschedule)

Required. The type of the reschedule the user wants.

SqlInstancesStartExternalSyncRequest

Instance start external sync request.
Fields
mysqlSyncConfig

object (MySqlSyncConfig)

MySQL-specific settings for start external sync.

skipVerification

boolean

Whether to skip the verification step (VESS).

syncMode

enum

External sync mode.

Enum type. Can be one of the following:
EXTERNAL_SYNC_MODE_UNSPECIFIED Unknown external sync mode, will be defaulted to ONLINE mode
ONLINE Online external sync will set up replication after initial data external sync
OFFLINE Offline external sync only dumps and loads a one-time snapshot of the primary instance's data

SqlInstancesVerifyExternalSyncSettingsRequest

Instance verify external sync settings request.
Fields
mysqlSyncConfig

object (MySqlSyncConfig)

Optional. MySQL-specific settings for start external sync.

syncMode

enum

External sync mode

Enum type. Can be one of the following:
EXTERNAL_SYNC_MODE_UNSPECIFIED Unknown external sync mode, will be defaulted to ONLINE mode
ONLINE Online external sync will set up replication after initial data external sync
OFFLINE Offline external sync only dumps and loads a one-time snapshot of the primary instance's data
verifyConnectionOnly

boolean

Flag to enable verifying connection only

SqlInstancesVerifyExternalSyncSettingsResponse

Instance verify external sync settings response.
Fields
errors[]

object (SqlExternalSyncSettingError)

List of migration violations.

kind

string

This is always sql#migrationSettingErrorList.

warnings[]

object (SqlExternalSyncSettingError)

List of migration warnings.

SqlOutOfDiskReport

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

integer (int32 format)

The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend

sqlOutOfDiskState

enum

This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job

Enum type. Can be one of the following:
SQL_OUT_OF_DISK_STATE_UNSPECIFIED Unspecified state
NORMAL The instance has plenty space on data disk
SOFT_SHUTDOWN Data disk is almost used up. It is shutdown to prevent data corruption.

SqlScheduledMaintenance

Any scheduled maintenancce for this instance.
Fields
canDefer

boolean

(No description provided)

canReschedule

boolean

If the scheduled maintenance can be rescheduled.

scheduleDeadlineTime

string (Timestamp format)

Maintenance cannot be rescheduled to start beyond this deadline.

startTime

string (Timestamp format)

The start time of any upcoming scheduled maintenance for this instance.

SqlServerDatabaseDetails

Represents a Sql Server database on the Cloud SQL instance.
Fields
compatibilityLevel

integer (int32 format)

The version of SQL Server with which the database is to be made compatible

recoveryModel

string

The recovery model of a SQL Server database

SqlServerUserDetails

Represents a Sql Server user on the Cloud SQL instance.
Fields
disabled

boolean

If the user has been disabled

serverRoles[]

string

The server roles for this user

SslCert

SslCerts Resource
Fields
cert

string

PEM representation.

certSerialNumber

string

Serial number, as extracted from the certificate.

commonName

string

User supplied name. Constrained to [a-zA-Z.-_ ]+.

createTime

string (Timestamp format)

The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z

expirationTime

string (Timestamp format)

The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

instance

string

Name of the database instance.

kind

string

This is always sql#sslCert.

selfLink

string

The URI of this resource.

sha1Fingerprint

string

Sha1 Fingerprint.

SslCertDetail

SslCertDetail.
Fields
certInfo

object (SslCert)

The public information about the cert.

certPrivateKey

string

The private key for the client cert, in pem format. Keep private in order to protect your security.

SslCertsCreateEphemeralRequest

SslCerts create ephemeral certificate request.
Fields
access_token

string

Access token to include in the signed certificate.

public_key

string

PEM encoded public key to include in the signed certificate.

SslCertsInsertRequest

SslCerts insert request.
Fields
commonName

string

User supplied name. Must be a distinct name from the other certificates for this instance.

SslCertsInsertResponse

SslCert insert response.
Fields
clientCert

object (SslCertDetail)

The new client certificate and private key.

kind

string

This is always sql#sslCertsInsert.

operation

object (Operation)

The operation to track the ssl certs insert request.

operation.exportContext.csvExportOptions.selectQuery

string

The select query used to extract the data.

operation.exportContext.sqlExportOptions.mysqlExportOptions

object

Options for exporting from MySQL.

operation.exportContext.sqlExportOptions.mysqlExportOptions.masterData

integer (int32 format)

Option to include SQL statement required to set up replication. If set to 1, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to 2, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than 1, --set-gtid-purged is set to OFF.

operation.exportContext.sqlExportOptions.schemaOnly

boolean

Export only schemas.

operation.exportContext.sqlExportOptions.tables[]

string

Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

operation.importContext.bakImportOptions.encryptionOptions

object

(No description provided)

operation.importContext.bakImportOptions.encryptionOptions.certPath

string

Path to the Certificate (.cer) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

operation.importContext.bakImportOptions.encryptionOptions.pvkPassword

string

Password that encrypts the private key

operation.importContext.bakImportOptions.encryptionOptions.pvkPath

string

Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

operation.importContext.csvImportOptions.columns[]

string

The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

operation.importContext.csvImportOptions.table

string

The table to which CSV data is imported.

serverCaCert

object (SslCert)

The server Certificate Authority's certificate. If this is missing you can force a new one to be generated by calling resetSslConfig method on instances resource.

SslCertsListResponse

SslCerts list response.
Fields
items[]

object (SslCert)

List of client certificates for the instance.

kind

string

This is always sql#sslCertsList.

SyncFlags

Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.
Fields
name

string

The name of the flag.

value

string

The value of the flag. This field must be omitted if the flag doesn't take a value.

Tier

A Google Cloud SQL service tier resource.
Fields
DiskQuota

string (int64 format)

The maximum disk size of this tier in bytes.

RAM

string (int64 format)

The maximum RAM usage of this tier in bytes.

kind

string

This is always sql#tier.

region[]

string

The applicable regions for this tier.

tier

string

An identifier for the machine type, for example, db-custom-1-3840. For related information, see Pricing.

TiersListResponse

Tiers list response.
Fields
items[]

object (Tier)

List of tiers.

kind

string

This is always sql#tiersList.

TruncateLogContext

Database Instance truncate log context.
Fields
kind

string

This is always sql#truncateLogContext.

logType

string

The type of log to truncate. Valid values are MYSQL_GENERAL_TABLE and MYSQL_SLOW_TABLE.

User

A Cloud SQL user resource.
Fields
etag

string

This field is deprecated and will be removed from a future version of the API.

host

string

The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion.

instance

string

The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update since it is already specified on the URL.

kind

string

This is always sql#user.

name

string

The name of the user in the Cloud SQL instance. Can be omitted for update since it is already specified in the URL.

password

string

The password for the user.

project

string

The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update since it is already specified on the URL.

sqlserverUserDetails

object (SqlServerUserDetails)

(No description provided)

type

enum

The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.

Enum type. Can be one of the following:
BUILT_IN The database's built-in user type.
CLOUD_IAM_USER Cloud IAM user.
CLOUD_IAM_SERVICE_ACCOUNT Cloud IAM service account.

UsersListResponse

User list response.
Fields
items[]

object (User)

List of user resources in the instance.

kind

string

This is always sql#usersList.

nextPageToken

string

An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.