package google.cloud.sql.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Service that exposes Cloud SQL database versions information. This service is only used internally.
(no methods)
Service for managing database backups.
rpc Delete (, )
cloud_sql_backup_runs.proto:40Deletes the backup taken by a backup run.
message
cloud_sql_backup_runs.proto:72Backup runs delete request.
int64 id = 1
The ID of the backup run to delete. To find a backup run ID, use the [list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/backupRuns/list) method.
string instance = 2
Cloud SQL instance ID. This does not include the project ID.
string project = 3
Project ID of the project that contains the instance.
rpc Get (, )
cloud_sql_backup_runs.proto:47Retrieves a resource containing information about a backup run.
message
cloud_sql_backup_runs.proto:86Backup runs get request.
int64 id = 1
The ID of this backup run.
string instance = 2
Cloud SQL instance ID. This does not include the project ID.
string project = 3
Project ID of the project that contains the instance.
rpc Insert (, )
cloud_sql_backup_runs.proto:54Creates a new backup run on demand.
message
cloud_sql_backup_runs.proto:98Backup runs insert request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
optional body = 100
rpc List (, )
cloud_sql_backup_runs.proto:64Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.
message
cloud_sql_backup_runs.proto:109Backup runs list request.
string instance = 1
Cloud SQL instance ID, or "-" for all instances. This does not include the project ID.
int32 max_results = 2
Maximum number of backup runs per response.
string page_token = 3
A previously-returned page token representing part of the larger set of results to view.
string project = 4
Project ID of the project that contains the instance.
message
cloud_sql_backup_runs.proto:197Backup run list results.
string kind = 1
This is always `sql#backupRunsList`.
repeated items = 2
A list of backup runs in reverse chronological order of the enqueued time.
string next_page_token = 3
The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
Cloud SQL connect service.
Retrieves connect settings about a Cloud SQL instance.
message
cloud_sql_connect.proto:61Connect settings retrieval request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
optional read_time = 7
Optional. Optional snapshot read timestamp to trade freshness for performance.
message
cloud_sql_connect.proto:75Connect settings retrieval response.
string kind = 1
This is always `sql#connectSettings`.
optional server_ca_cert = 2
SSL configuration.
repeated ip_addresses = 3
The assigned IP addresses for the instance.
string region = 4
The cloud region for the instance. For example, `us-central1`, `europe-west1`. The region cannot be changed after instance creation.
SqlDatabaseVersion database_version = 31
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` (default), `POSTGRES_13`, or `POSTGRES_14`. SQL Server instances: `SQLSERVER_2017_STANDARD` (default), `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`.
SqlBackendType backend_type = 32
`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.
bool psc_enabled = 33
Whether PSC connectivity is enabled for this instance.
string dns_name = 34
The dns name of the instance.
ConnectSettings.CaMode server_ca_mode = 35
Specify what type of CA is used for the server certificate.
Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
message
cloud_sql_connect.proto:132Ephemeral certificate creation request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
string public_key = 3
PEM encoded public key to include in the signed certificate.
string access_token = 4
Optional. Access token to include in the signed certificate.
optional read_time = 7
Optional. Optional snapshot read timestamp to trade freshness for performance.
optional valid_duration = 12
Optional. If set, it will contain the cert valid duration.
message
cloud_sql_connect.proto:157Ephemeral certificate creation request.
optional ephemeral_cert = 1
Generated cert
Service to manage databases.
rpc Delete (, )
cloud_sql_databases.proto:38Deletes a database from a Cloud SQL instance.
message
cloud_sql_databases.proto:90Database delete request.
string database = 1
Name of the database to be deleted in the instance.
string instance = 2
Database instance ID. This does not include the project ID.
string project = 3
Project ID of the project that contains the instance.
rpc Get (, )
cloud_sql_databases.proto:46Retrieves a resource containing information about a database inside a Cloud SQL instance.
message
cloud_sql_databases.proto:102Database get request.
string database = 1
Name of the database in the instance.
string instance = 2
Database instance ID. This does not include the project ID.
string project = 3
Project ID of the project that contains the instance.
rpc Insert (, )
cloud_sql_databases.proto:56Inserts a resource containing information about a database inside a Cloud SQL instance. **Note:** You can't modify the default character set and collation.
message
cloud_sql_databases.proto:114Database insert request.
string instance = 1
Database instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
optional body = 100
rpc List (, )
cloud_sql_databases.proto:64Lists databases in the specified Cloud SQL instance.
message
cloud_sql_databases.proto:125Database list request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
message
cloud_sql_databases.proto:148Database list response.
string kind = 1
This is always `sql#databasesList`.
repeated items = 2
List of database resources in the instance.
rpc Patch (, )
cloud_sql_databases.proto:72Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.
rpc Update (, )
cloud_sql_databases.proto:81Updates a resource containing information about a database inside a Cloud SQL instance.
Service that exposes Cloud SQL event information. This service is only used internally.
(no methods)
Service to manage database flags for Cloud SQL instances.
rpc List (, )
cloud_sql_flags.proto:39Lists all available database flags for Cloud SQL instances.
message
cloud_sql_flags.proto:47Flags list request.
string database_version = 1
Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.
message
cloud_sql_flags.proto:54Flags list response.
string kind = 1
This is always `sql#flagsList`.
repeated items = 2
List of flags.
Service for providing IAM Meta APIs for Cloud SQL.
(no methods)
Cloud SQL instance names service.
(no methods)
Service to manage Cloud SQL instances.
Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.
message
cloud_sql_instances.proto:346Instance add server CA request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
rpc Clone (, )
cloud_sql_instances.proto:54Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.
message
cloud_sql_instances.proto:355Instance clone request.
string instance = 1
The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
string project = 2
Project ID of the source as well as the clone Cloud SQL instance.
optional body = 100
rpc Delete (, )
cloud_sql_instances.proto:62Deletes a Cloud SQL instance.
message
cloud_sql_instances.proto:367Instance delete request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance to be deleted.
Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.
message
cloud_sql_instances.proto:376Instance demote master request.
string instance = 1
Cloud SQL instance name.
string project = 2
ID of the project that contains the instance.
optional body = 100
rpc Demote (, )
cloud_sql_instances.proto:79Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.
message
cloud_sql_instances.proto:387Instance demote request.
string instance = 1
Required. Cloud SQL instance name.
string project = 2
Required. ID of the project that contains the instance.
optional body = 100
Required. The request body.
rpc Export (, )
cloud_sql_instances.proto:88Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.
message
cloud_sql_instances.proto:399Instance export request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance to be exported.
optional body = 100
Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the [Overview of high availability](https://cloud.google.com/sql/docs/mysql/high-availability) page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.
message
cloud_sql_instances.proto:410Instance failover request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
ID of the project that contains the read replica.
optional body = 100
Reencrypt CMEK instance with latest key version.
message
cloud_sql_instances.proto:633Instance reencrypt request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
ID of the project that contains the instance.
optional body = 3
Reencrypt body that users request
rpc Get (, )
cloud_sql_instances.proto:119Retrieves a resource containing information about a Cloud SQL instance.
message
cloud_sql_instances.proto:421Instance get request.
string instance = 1
Database instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
rpc Import (, )
cloud_sql_instances.proto:127Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.
message
cloud_sql_instances.proto:430Instance import request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
optional body = 100
rpc Insert (, )
cloud_sql_instances.proto:135Creates a new Cloud SQL instance.
message
cloud_sql_instances.proto:441Instance insert request.
string project = 1
Project ID of the project to which the newly created Cloud SQL instances should belong.
optional body = 100
rpc List (, )
cloud_sql_instances.proto:143Lists instances under a given project.
message
cloud_sql_instances.proto:450Instance list request.
string filter = 1
A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.
uint32 max_results = 2
The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
string page_token = 3
A previously-returned page token representing part of the larger set of results to view.
string project = 4
Project ID of the project for which to list Cloud SQL instances.
message
cloud_sql_instances.proto:853Database instances list response.
string kind = 1
This is always `sql#instancesList`.
repeated warnings = 2
List of warnings that occurred while handling the request.
repeated items = 3
List of database instance resources.
string next_page_token = 4
The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.
message
cloud_sql_instances.proto:477Instance list server CAs request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
message
cloud_sql_instances.proto:869Instances ListServerCas response.
repeated certs = 1
List of server CA certificates for the instance.
string active_version = 2
string kind = 3
This is always `sql#instancesListServerCas`.
rpc Patch (, )
cloud_sql_instances.proto:163Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.
message
cloud_sql_instances.proto:486Instance patch request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
optional body = 100
Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.
message
cloud_sql_instances.proto:497Instance promote replica request.
string instance = 1
Cloud SQL read replica instance name.
string project = 2
ID of the project that contains the read replica.
bool failover = 3
Set to true to invoke a replica failover to the designated DR replica. As part of replica failover, the promote operation attempts to add the original primary instance as a replica of the promoted DR replica when the original primary instance comes back online. If set to false or not specified, then the original primary instance becomes an independent Cloud SQL primary instance. Only applicable to MySQL.
Switches over from the primary instance to the designated DR replica instance.
message
cloud_sql_instances.proto:515Instance switchover request.
string instance = 1
Cloud SQL read replica instance name.
string project = 2
ID of the project that contains the replica.
optional db_timeout = 3
Optional. (MySQL only) Cloud SQL instance operations timeout, which is a sum of all database operations. Default value is 10 minutes and can be modified to a maximum value of 24 hours.
Deletes all client certificates and generates a new server SSL certificate for the instance.
message
cloud_sql_instances.proto:530Instance reset SSL config request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
rpc Restart (, )
cloud_sql_instances.proto:196Restarts a Cloud SQL instance.
message
cloud_sql_instances.proto:539Instance restart request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance to be restarted.
Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.
message
cloud_sql_instances.proto:548Instance restore backup request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
optional body = 100
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.
message
cloud_sql_instances.proto:559Instance rotate server CA request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
optional body = 100
Starts the replication in the read replica instance.
message
cloud_sql_instances.proto:570Instance start replica request.
string instance = 1
Cloud SQL read replica instance name.
string project = 2
ID of the project that contains the read replica.
Stops the replication in the read replica instance.
message
cloud_sql_instances.proto:579Instance stop replica request.
string instance = 1
Cloud SQL read replica instance name.
string project = 2
ID of the project that contains the read replica.
Truncate MySQL general and slow query log tables MySQL only.
message
cloud_sql_instances.proto:588Instance truncate log request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the Cloud SQL project.
optional body = 100
rpc Update (, )
cloud_sql_instances.proto:247Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.
message
cloud_sql_instances.proto:611Instance update request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
optional body = 100
Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
message
cloud_sql_instances.proto:796Instance create ephemeral certificate request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the Cloud SQL project.
optional body = 100
Reschedules the maintenance on the given instance.
message
cloud_sql_instances.proto:622Instance reschedule maintenance request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
ID of the project that contains the instance.
optional body = 100
Verify External primary instance external sync settings.
message
cloud_sql_instances.proto:696Instance verify external sync settings request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
bool verify_connection_only = 3
Flag to enable verifying connection only
SqlInstancesVerifyExternalSyncSettingsRequest.ExternalSyncMode sync_mode = 4
External sync mode
bool verify_replication_only = 5
Optional. Flag to verify settings required by replication setup only
oneof sync_config
mysql_sync_config = 6
Optional. MySQL-specific settings for start external sync.
SqlInstancesVerifyExternalSyncSettingsRequest.MigrationType migration_type = 7
Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL.
ExternalSyncParallelLevel sync_parallel_level = 8
Optional. Parallel level for initial data sync. Only applicable for PostgreSQL.
message
cloud_sql_instances.proto:904Instance verify external sync settings response.
string kind = 1
This is always `sql#migrationSettingErrorList`.
repeated errors = 2
List of migration violations.
repeated warnings = 3
List of migration warnings.
Start External primary instance migration.
message
cloud_sql_instances.proto:756Instance start external sync request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
ID of the project that contains the instance.
SqlInstancesVerifyExternalSyncSettingsRequest.ExternalSyncMode sync_mode = 3
External sync mode.
bool skip_verification = 4
Whether to skip the verification step (VESS).
oneof sync_config
mysql_sync_config = 6
MySQL-specific settings for start external sync.
ExternalSyncParallelLevel sync_parallel_level = 7
Optional. Parallel level for initial data sync. Currently only applicable for MySQL.
SqlInstancesVerifyExternalSyncSettingsRequest.MigrationType migration_type = 8
Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL.
Perform Disk Shrink on primary instance.
message
cloud_sql_instances.proto:599Instance perform disk shrink request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
optional body = 100
Perform disk shrink context.
Get Disk Shrink Config for a given instance.
message
cloud_sql_instances.proto:687Instance get disk shrink config request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
message
cloud_sql_instances.proto:916Instance get disk shrink config response.
string kind = 1
This is always `sql#getDiskShrinkConfig`.
int64 minimal_target_size_gb = 2
The minimum size to which a disk can be shrunk in GigaBytes.
string message = 3
Additional message to customers.
Reset Replica Size to primary instance disk size.
message
cloud_sql_instances.proto:787Instance reset replica size request.
string instance = 1
Cloud SQL read replica instance name.
string project = 2
ID of the project that contains the read replica.
Get Latest Recovery Time for a given instance.
message
cloud_sql_instances.proto:928Instance get latest recovery time request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
message
cloud_sql_instances.proto:937Instance get latest recovery time response.
string kind = 1
This is always `sql#getLatestRecoveryTime`.
optional latest_recovery_time = 2
Timestamp, identifies the latest recovery time of the source instance.
Acquire a lease for the setup of SQL Server Reporting Services (SSRS).
message
cloud_sql_instances.proto:1712Request to acquire a lease for SSRS.
string instance = 1
Required. Cloud SQL instance ID. This doesn't include the project ID. It's composed of lowercase letters, numbers, and hyphens, and it must start with a letter. The total length must be 98 characters or less (Example: instance-id).
string project = 2
Required. Project ID of the project that contains the instance (Example: project-id).
optional body = 100
Required. The request body.
message
cloud_sql_instances.proto:1729Response for the acquire SSRS lease request.
string operation_id = 1
The unique identifier for this operation.
Release a lease for the setup of SQL Server Reporting Services (SSRS).
message
cloud_sql_instances.proto:1735Request to release a lease for SSRS.
string instance = 1
Required. The Cloud SQL instance ID. This doesn't include the project ID. The instance ID contains lowercase letters, numbers, and hyphens, and it must start with a letter. This ID can have a maximum length of 98 characters.
string project = 2
Required. The project ID that contains the instance.
message
cloud_sql_instances.proto:1747Response for the release SSRS lease request.
string operation_id = 1
The unique identifier for this operation.
Service to fetch operations for database instances.
rpc Get (, )
cloud_sql_operations.proto:40Retrieves an instance operation that has been performed on an instance.
message
cloud_sql_operations.proto:63Operations get request.
string operation = 1
Instance operation ID.
string project = 2
Project ID of the project that contains the instance.
rpc List (, )
cloud_sql_operations.proto:48Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.
message
cloud_sql_operations.proto:72Operations list request.
string instance = 1
Cloud SQL instance ID. This does not include the project ID.
uint32 max_results = 2
Maximum number of operations per response.
string page_token = 3
A previously-returned page token representing part of the larger set of results to view.
string project = 4
Project ID of the project that contains the instance.
message
cloud_sql_operations.proto:88Operations list response.
string kind = 1
This is always `sql#operationsList`.
repeated items = 2
List of operation resources.
string next_page_token = 3
The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
rpc Cancel (, )
cloud_sql_operations.proto:55Cancels an instance operation that has been performed on an instance.
message
cloud_sql_operations.proto:101Operations cancel request.
string operation = 1
Instance operation ID.
string project = 2
Project ID of the project that contains the instance.
Service that exposes Cloud SQL region information. This service is only used internally and does not follow the same patterns as the other v1 RPCs.
(no methods)
Service to manage SSL certs for Cloud SQL instances.
rpc Delete (, )
cloud_sql_ssl_certs.proto:39Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.
message
cloud_sql_ssl_certs.proto:72string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
string sha1_fingerprint = 3
Sha1 FingerPrint.
rpc Get (, )
cloud_sql_ssl_certs.proto:48Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.
message
cloud_sql_ssl_certs.proto:83string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
string sha1_fingerprint = 3
Sha1 FingerPrint.
rpc Insert (, )
cloud_sql_ssl_certs.proto:57Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.
message
cloud_sql_ssl_certs.proto:94string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
optional body = 100
message
cloud_sql_ssl_certs.proto:120SslCert insert response.
string kind = 1
This is always `sql#sslCertsInsert`.
optional operation = 2
The operation to track the ssl certs insert request.
optional server_ca_cert = 3
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.
optional client_cert = 4
The new client certificate and private key.
rpc List (, )
cloud_sql_ssl_certs.proto:65Lists all of the current SSL certificates for the instance.
message
cloud_sql_ssl_certs.proto:104string instance = 1
Cloud SQL instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
message
cloud_sql_ssl_certs.proto:137SslCerts list response.
string kind = 1
This is always `sql#sslCertsList`.
repeated items = 2
List of client certificates for the instance.
Service for providing machine types (tiers) for Cloud SQL instances.
rpc List (, )
cloud_sql_tiers.proto:39Lists all available machine types (tiers) for Cloud SQL, for example, `db-custom-1-3840`. For more information, see https://cloud.google.com/sql/pricing.
message
cloud_sql_tiers.proto:47Tiers list request.
string project = 1
Project ID of the project for which to list tiers.
message
cloud_sql_tiers.proto:53Tiers list response.
string kind = 1
This is always `sql#tiersList`.
repeated items = 2
List of tiers.
Cloud SQL users service.
rpc Delete (, )
cloud_sql_users.proto:39Deletes a user from a Cloud SQL instance.
message
cloud_sql_users.proto:76string host = 1
Host of the user in the instance.
string instance = 2
Database instance ID. This does not include the project ID.
string name = 3
Name of the user in the instance.
string project = 4
Project ID of the project that contains the instance.
rpc Get (, )
cloud_sql_users.proto:46Retrieves a resource containing information about a user.
message
cloud_sql_users.proto:91Request message for Users Get RPC
string instance = 1
Database instance ID. This does not include the project ID.
string name = 2
User of the instance.
string project = 3
Project ID of the project that contains the instance.
string host = 4
Host of a user of the instance.
rpc Insert (, )
cloud_sql_users.proto:53Creates a new user in a Cloud SQL instance.
message
cloud_sql_users.proto:105string instance = 1
Database instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
optional body = 100
rpc List (, )
cloud_sql_users.proto:61Lists users in the specified Cloud SQL instance.
message
cloud_sql_users.proto:115string instance = 1
Database instance ID. This does not include the project ID.
string project = 2
Project ID of the project that contains the instance.
message
cloud_sql_users.proto:262User list response.
string kind = 1
This is always `sql#usersList`.
repeated items = 2
List of user resources in the instance.
string next_page_token = 3
Unused.
rpc Update (, )
cloud_sql_users.proto:68Updates an existing user in a Cloud SQL instance.
message
cloud_sql_users.proto:123string host = 1
Optional. Host of the user in the instance.
string instance = 2
Database instance ID. This does not include the project ID.
string name = 3
Name of the user in the instance.
string project = 4
Project ID of the project that contains the instance.
optional body = 100
message
cloud_sql_resources.proto:30An entry for an Access Control list.
Used in:
string value = 1
The allowlisted value for the access control list.
optional expiration_time = 2
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 name = 3
Optional. A label to identify this entry.
string kind = 4
This is always `sql#aclEntry`.
message
cloud_sql_resources.proto:1735Acquire SSRS lease context.
Used in: ,
optional string setup_login = 1
The username to be used as the setup login to connect to the database server for SSRS setup.
optional string service_login = 2
The username to be used as the service login to connect to the report database for SSRS setup.
optional string report_database = 3
The report database to be used for SSRS setup.
optional duration = 4
Lease duration needed for SSRS setup.
message
cloud_sql_resources.proto:1412Specifies options for controlling advanced machine features.
Used in:
int32 threads_per_core = 1
The number of threads per physical core.
message
cloud_sql_resources.proto:47An Admin API warning message.
Used in: ,
ApiWarning.SqlApiWarningCode code = 1
Code to uniquely identify the warning type.
string message = 2
The warning message.
string region = 3
The region name for REGION_UNREACHABLE warning.
Used in:
SQL_API_WARNING_CODE_UNSPECIFIED = 0
An unknown or unset warning type from Cloud SQL API.
REGION_UNREACHABLE = 1
Warning when one or more regions are not reachable. The returned result set may be incomplete.
MAX_RESULTS_EXCEEDS_LIMIT = 2
Warning when user provided maxResults parameter exceeds the limit. The returned result set may be incomplete.
COMPROMISED_CREDENTIALS = 3
Warning when user tries to create/update a user with credentials that have previously been compromised by a public data breach.
INTERNAL_STATE_FAILURE = 4
Warning when the operation succeeds but some non-critical workflow state failed.
message
cloud_sql_instances.proto:1344An available database version. It can be a major or a minor version.
Used in:
optional string major_version = 3
The version's major version name.
optional string name = 8
The database version name. For MySQL 8.0, this string provides the database major and minor version.
optional string display_name = 9
The database version's display name.
message
cloud_sql_resources.proto:101Database instance backup configuration.
Used in:
string start_time = 1
Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`.
optional enabled = 2
Whether this configuration is enabled.
string kind = 3
This is always `sql#backupConfiguration`.
optional binary_log_enabled = 4
(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
optional replication_log_archiving_enabled = 5
Reserved for future use.
string location = 6
Location of the backup
optional point_in_time_recovery_enabled = 7
Whether point in time recovery is enabled.
optional backup_retention_settings = 8
Backup retention settings.
optional transaction_log_retention_days = 9
The number of days of transaction logs we retain for point in time restore, from 1-7.
optional BackupConfiguration.TransactionalLogStorageState transactional_log_storage_state = 10
Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database.
This value contains the storage location of the transactional logs used to perform point-in-time recovery (PITR) for the database.
Used in:
TRANSACTIONAL_LOG_STORAGE_STATE_UNSPECIFIED = 0
Unspecified.
DISK = 1
The transaction logs used for PITR for the instance are stored on a data disk.
SWITCHING_TO_CLOUD_STORAGE = 2
The transaction logs used for PITR for the instance are switching from being stored on a data disk to being stored in Cloud Storage. Only applicable to MySQL.
SWITCHED_TO_CLOUD_STORAGE = 3
The transaction logs used for PITR for the instance are now stored in Cloud Storage. Previously, they were stored on a data disk. Only applicable to MySQL.
CLOUD_STORAGE = 4
The transaction logs used for PITR for the instance are stored in Cloud Storage. Only applicable to MySQL and PostgreSQL.
message
cloud_sql_resources.proto:170Backup context.
Used in:
int64 backup_id = 1
The identifier of the backup.
string kind = 2
This is always `sql#backupContext`.
message
cloud_sql_instances.proto:651Backup Reencryption Config
Used in:
optional int32 backup_limit = 1
Backup re-encryption limit
optional BackupReencryptionConfig.BackupType backup_type = 2
Type of backups users want to re-encrypt.
Backup type for re-encryption
Used in:
BACKUP_TYPE_UNSPECIFIED = 0
Unknown backup type, will be defaulted to AUTOMATIC backup type
AUTOMATED = 1
Reencrypt automatic backups
ON_DEMAND = 2
Reencrypt on-demand backups
message
cloud_sql_resources.proto:81We currently only support backup retention by specifying the number of backups we will retain.
Used in:
BackupRetentionSettings.RetentionUnit retention_unit = 1
The unit that 'retained_backups' represents.
optional retained_backups = 2
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.
The units that retained_backups specifies, we only support COUNT.
Used in:
RETENTION_UNIT_UNSPECIFIED = 0
Backup retention unit is unspecified, will be treated as COUNT.
COUNT = 1
Retention will be by count, eg. "retain the most recent 7 backups".
message
cloud_sql_backup_runs.proto:126A BackupRun resource.
Used as response type in: SqlBackupRunsService.Get
Used as field type in: ,
string kind = 1
This is always `sql#backupRun`.
SqlBackupRunStatus status = 2
The status of this run.
optional enqueued_time = 3
The time the run was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
int64 id = 4
The identifier for this backup run. Unique only for a specific Cloud SQL instance.
optional start_time = 5
The time the backup operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
optional end_time = 6
The time the backup operation completed in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
optional error = 7
Information about why the backup operation failed. This is only present if the run has the FAILED status.
SqlBackupRunType type = 8
The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
string description = 9
The description of this run, only applicable to on-demand backups.
optional window_start_time = 10
The start time of the backup window during which this the backup was attempted in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
string instance = 11
Name of the database instance.
string self_link = 12
The URI of this resource.
string location = 13
Location of the backups.
optional disk_encryption_configuration = 16
Encryption configuration specific to a backup.
optional disk_encryption_status = 17
Encryption status specific to a backup.
SqlBackupKind backup_kind = 19
Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
string time_zone = 23
Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
optional int64 max_chargeable_bytes = 24
Output only. The maximum chargeable bytes for the backup.
Used in: ,
BAK_TYPE_UNSPECIFIED = 0
Default type.
FULL = 1
Full backup.
DIFF = 2
Differential backup.
TLOG = 3
Transaction Log backup
message
cloud_sql_instances.proto:985Binary log coordinates.
Used in:
string bin_log_file_name = 1
Name of the binary log file for a Cloud SQL instance.
int64 bin_log_position = 2
Position (offset) within the binary log file.
string kind = 3
This is always `sql#binLogCoordinates`.
message
cloud_sql_instances.proto:946Database instance clone context.
Used in:
string kind = 1
This is always `sql#cloneContext`.
int64 pitr_timestamp_ms = 2
Reserved for future use.
string destination_instance_name = 3
Name of the Cloud SQL instance to be created as a clone.
optional bin_log_coordinates = 4
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.
optional point_in_time = 5
Timestamp, if specified, identifies the time to which the source instance is cloned.
string allocated_ip_range = 6
The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). 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.
repeated string database_names = 9
(SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.
optional string preferred_zone = 10
Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types.
Various Certificate Authority (CA) modes for certificate signing.
Used in:
CA_MODE_UNSPECIFIED = 0
CA mode is unknown.
GOOGLE_MANAGED_INTERNAL_CA = 1
Google-managed self-signed internal CA.
GOOGLE_MANAGED_CAS_CA = 2
Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS).
message
cloud_sql_resources.proto:1208Data cache configurations.
Used in:
bool data_cache_enabled = 1
Whether data cache is enabled for the instance.
message
cloud_sql_resources.proto:179Represents a SQL database on the Cloud SQL instance.
Used as response type in: SqlDatabasesService.Get
Used as field type in: , ,
string kind = 1
This is always `sql#database`.
string charset = 2
The Cloud SQL charset value.
string collation = 3
The Cloud SQL collation value.
string etag = 4
This field is deprecated and will be removed from a future version of the API.
string name = 5
The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
string instance = 6
The name of the Cloud SQL instance. This does not include the project ID.
string self_link = 7
The URI of this resource.
string project = 8
The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
oneof database_details
sqlserver_database_details = 9
message
cloud_sql_resources.proto:222Database flags for Cloud SQL instances.
Used in:
string name = 1
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](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation.
string value = 2
The value of the flag. Boolean flags are set to `on` for true and `off` for false. This field must be omitted if the flag doesn't take a value.
message
cloud_sql_instances.proto:997A Cloud SQL instance resource.
Used as response type in: SqlInstancesService.Get
Used as field type in: , , ,
string kind = 1
This is always `sql#instance`.
DatabaseInstance.SqlInstanceState state = 2
The current serving state of the Cloud SQL instance.
SqlDatabaseVersion database_version = 3
The database engine type and version. The `databaseVersion` field cannot be changed after instance creation.
optional settings = 4
The user settings.
string etag = 5
This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead.
optional failover_replica = 6
The name and status of the failover replica.
string master_instance_name = 7
The name of the instance which will act as primary in the replication setup.
repeated string replica_names = 8
The replicas of the instance.
optional max_disk_size = 9
The maximum disk size of the instance in bytes.
optional current_disk_size = 10
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](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details.
repeated ip_addresses = 11
The assigned IP addresses for the instance.
optional server_ca_cert = 12
SSL configuration.
SqlInstanceType instance_type = 13
The instance type.
string project = 14
The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
string ipv6_address = 15
The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
string service_account_email_address = 16
The service account email address assigned to the instance.\This property is read-only.
optional on_premises_configuration = 17
Configuration specific to on-premises instances.
optional replica_configuration = 18
Configuration specific to failover replicas and read replicas.
SqlBackendType backend_type = 19
The backend type. `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.
string self_link = 20
The URI of this resource.
repeated SqlSuspensionReason suspension_reason = 21
If the instance state is SUSPENDED, the reason for the suspension.
string connection_name = 22
Connection name of the Cloud SQL instance used in connection strings.
string name = 23
Name of the Cloud SQL instance. This does not include the project ID.
string region = 24
The geographical region of the Cloud SQL instance. It can be one of the [regions](https://cloud.google.com/sql/docs/mysql/locations#location-r) where Cloud SQL operates: For example, `asia-east1`, `europe-west1`, and `us-central1`. The default value is `us-central1`.
string gce_zone = 25
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. WARNING: Changing this might restart the instance.
string secondary_gce_zone = 34
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.
optional disk_encryption_configuration = 26
Disk encryption configuration specific to an instance.
optional disk_encryption_status = 27
Disk encryption status specific to an instance.
string root_password = 29
Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
optional scheduled_maintenance = 30
The start time of any upcoming scheduled maintenance for this instance.
optional satisfies_pzs = 35
This status indicates whether the instance satisfies PZS. The status is reserved for future use.
string database_installed_version = 40
Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`.
optional out_of_disk_report = 38
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 proactive database wellness job
optional create_time = 39
Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
repeated string available_maintenance_versions = 41
Output only. List all maintenance versions applicable on the instance
string maintenance_version = 42
The current software version on the instance.
repeated upgradable_database_versions = 45
Output only. All database versions that are available for upgrade.
optional DatabaseInstance.SqlNetworkArchitecture sql_network_architecture = 47
optional string psc_service_attachment_link = 48
Output only. The link to service attachment of PSC instance.
optional string dns_name = 49
Output only. The dns name of the instance.
optional string primary_dns_name = 51
Output only. DEPRECATED: please use write_endpoint instead.
optional string write_endpoint = 52
Output only. The dns name of the primary instance in a replication group.
optional replication_cluster = 54
Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
optional gemini_config = 55
Gemini instance configuration.
optional satisfies_pzi = 56
Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use.
optional switch_transaction_logs_to_cloud_storage_enabled = 57
Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.
message
cloud_sql_instances.proto:1026Used in:
string name = 1
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.
optional available = 2
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.
The current serving state of the database instance.
Used in:
SQL_INSTANCE_STATE_UNSPECIFIED = 0
The state of the instance is unknown.
RUNNABLE = 1
The instance is running, or has been stopped by owner.
SUSPENDED = 2
The instance is not available, for example due to problems with billing.
PENDING_DELETE = 3
The instance is being deleted.
PENDING_CREATE = 4
The instance is being created.
MAINTENANCE = 5
The instance is down for maintenance.
FAILED = 6
The creation of the instance failed or a fatal error occurred during maintenance.
ONLINE_MAINTENANCE = 7
Deprecated
The SQL network architecture for the instance.
Used in:
SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0
NEW_NETWORK_ARCHITECTURE = 1
The instance uses the new network architecture.
OLD_NETWORK_ARCHITECTURE = 2
The instance uses the old network architecture.
message
cloud_sql_instances.proto:1053This message wraps up the information written by out-of-disk detection job.
Used in:
optional SqlOutOfDiskReport.SqlOutOfDiskState sql_out_of_disk_state = 1
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 proactive database wellness job
optional int32 sql_min_recommended_increase_size_gb = 2
The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers:
This enum lists all possible states regarding out-of-disk issues.
Used in:
SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0
Unspecified state
NORMAL = 1
The instance has plenty space on data disk
SOFT_SHUTDOWN = 2
Data disk is almost used up. It is shutdown to prevent data corruption.
message
cloud_sql_instances.proto:1039Any scheduled maintenance for this instance.
Used in:
optional start_time = 1
The start time of any upcoming scheduled maintenance for this instance.
bool can_defer = 2
bool can_reschedule = 3
If the scheduled maintenance can be rescheduled.
optional schedule_deadline_time = 4
Maintenance cannot be rescheduled to start beyond this deadline.
message
cloud_sql_instances.proto:1416This context is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.
Used in:
string kind = 1
This is always `sql#demoteContext`.
string source_representative_instance_name = 2
Required. The name of the instance which acts as the on-premises primary instance in the replication setup.
message
cloud_sql_resources.proto:269Read-replica configuration for connecting to the on-premises primary instance.
Used in:
string kind = 1
This is always `sql#demoteMasterConfiguration`.
optional mysql_replica_configuration = 2
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.
message
cloud_sql_instances.proto:1389Database instance demote primary instance context.
Used in:
string kind = 1
This is always `sql#demoteMasterContext`.
optional verify_gtid_consistency = 2
Verify the GTID consistency for demote operation. Default value: `True`. Setting this flag to `false` enables you to bypass the 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 only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues.
string master_instance_name = 3
The name of the instance which will act as on-premises primary instance in the replication setup.
optional replica_configuration = 4
Configuration specific to read-replicas replicating from the on-premises primary instance.
bool skip_replication_setup = 5
Flag to skip replication setup on the instance.
message
cloud_sql_resources.proto:283Read-replica configuration specific to MySQL databases.
Used in:
string kind = 1
This is always `sql#demoteMasterMysqlReplicaConfiguration`.
string username = 2
The username for the replication connection.
string password = 3
The password for the replication connection.
string client_key = 4
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.
string client_certificate = 5
PEM representation of the replica's x509 certificate.
string ca_certificate = 6
PEM representation of the trusted CA's x509 certificate.
message
cloud_sql_resources.proto:779Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied.
Used in:
string start_date = 1
"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 deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
string end_date = 2
"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
string time = 3
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
message
cloud_sql_resources.proto:865Disk encryption configuration for an instance.
Used in: ,
string kms_key_name = 1
Resource name of KMS key for disk encryption
string kind = 2
This is always `sql#diskEncryptionConfiguration`.
message
cloud_sql_resources.proto:874Disk encryption status for an instance.
Used in: ,
string kms_key_version_name = 1
KMS key version used to encrypt the Cloud SQL instance resource
string kind = 2
This is always `sql#diskEncryptionStatus`.
message
cloud_sql_resources.proto:319Database instance export context.
Used in: ,
string uri = 1
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.
repeated string databases = 2
Databases to be exported. <br /> `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. <br /> `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. <br /> `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
string kind = 3
This is always `sql#exportContext`.
optional sql_export_options = 4
Options for exporting data as SQL statements.
optional csv_export_options = 5
Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
SqlFileType file_type = 6
The file type for the specified uri.
optional offload = 8
Option for export offload.
optional bak_export_options = 9
Options for exporting data as BAK files.
message
cloud_sql_resources.proto:390Options for exporting BAK files (SQL Server-only)
Used in:
optional striped = 1
Whether or not the export should be striped.
optional stripe_count = 2
Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
BakType bak_type = 4
Type of this bak file will be export, FULL or DIFF, SQL Server only
optional copy_only = 5
Deprecated: copy_only is deprecated. Use differential_base instead
optional differential_base = 6
Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
message
cloud_sql_resources.proto:320Used in:
string select_query = 1
The select query used to extract the data.
string escape_character = 2
Specifies the character that should appear before a data character that needs to be escaped.
string quote_character = 3
Specifies the quoting character to be used when a data value is quoted.
string fields_terminated_by = 4
Specifies the character that separates columns within each row (line) of the file.
string lines_terminated_by = 6
This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
message
cloud_sql_resources.proto:340Used in:
repeated string tables = 1
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.
optional schema_only = 2
Export only schemas.
optional mysql_export_options = 3
optional threads = 4
Optional. The number of threads to use for parallel export.
optional parallel = 5
Optional. Whether or not the export should be parallel.
optional postgres_export_options = 6
Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.
message
cloud_sql_resources.proto:342Options for exporting from MySQL.
Used in:
optional master_data = 1
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.
message
cloud_sql_resources.proto:353Options for exporting from a Cloud SQL for PostgreSQL instance.
Used in:
optional clean = 1
Optional. Use this option to include DROP <object> SQL statements. These statements are used to delete database objects before running the import operation.
optional if_exists = 2
Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.
External Sync parallel level.
Used in: ,
EXTERNAL_SYNC_PARALLEL_LEVEL_UNSPECIFIED = 0
Unknown sync parallel level. Will be defaulted to OPTIMAL.
MIN = 1
Minimal parallel level.
OPTIMAL = 2
Optimal parallel level.
MAX = 3
Maximum parallel level.
message
cloud_sql_instances.proto:1427Database instance failover context.
Used in:
int64 settings_version = 1
The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version.
string kind = 2
This is always `sql#failoverContext`.
message
cloud_sql_flags.proto:63A flag resource.
Used in:
string name = 1
This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet`
SqlFlagType type = 2
The type of the flag. Flags are typed to being `BOOLEAN`, `STRING`, `INTEGER` or `NONE`. `NONE` is used for flags that do not take a value, such as `skip_grant_tables`.
repeated SqlDatabaseVersion applies_to = 3
The database version this flag applies to. Can be MySQL instances: `MYSQL_8_0`, `MYSQL_8_0_18`, `MYSQL_8_0_26`, `MYSQL_5_7`, or `MYSQL_5_6`. PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`, `POSTGRES_11` or `POSTGRES_12`. SQL Server instances: `SQLSERVER_2017_STANDARD`, `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`. See [the complete list](/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).
repeated string allowed_string_values = 4
For `STRING` flags, a list of strings that the value can be set to.
optional min_value = 5
For `INTEGER` flags, the minimum allowed value.
optional max_value = 6
For `INTEGER` flags, the maximum allowed value.
optional requires_restart = 7
Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.
string kind = 8
This is always `sql#flag`.
optional in_beta = 9
Whether or not the flag is considered in beta.
repeated int64 allowed_int_values = 10
Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.
message
cloud_sql_instances.proto:1291Gemini instance configuration.
Used in:
optional bool entitled = 1
Output only. Whether Gemini is enabled.
optional bool google_vacuum_mgmt_enabled = 2
Output only. Whether the vacuum management is enabled.
optional bool oom_session_cancel_enabled = 3
Output only. Whether canceling the out-of-memory (OOM) session is enabled.
optional bool active_query_enabled = 4
Output only. Whether the active query is enabled.
optional bool index_advisor_enabled = 5
Output only. Whether the index advisor is enabled.
optional bool flag_recommender_enabled = 6
Output only. Whether the flag recommender is enabled.
message
cloud_sql_resources.proto:452Database instance import context.
Used in: ,
string uri = 1
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.
string database = 2
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.
string kind = 3
This is always `sql#importContext`.
SqlFileType file_type = 4
The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data.
optional csv_import_options = 5
Options for importing data as CSV.
string import_user = 6
The PostgreSQL user for this import operation. PostgreSQL instances only.
optional bak_import_options = 7
Import parameters specific to SQL Server .BAK files
optional sql_import_options = 8
Optional. Options for importing data from SQL statements.
message
cloud_sql_resources.proto:503Used in:
optional encryption_options = 1
optional striped = 2
Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
optional no_recovery = 4
Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
optional recovery_only = 5
Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
BakType bak_type = 6
Type of the bak content, FULL or DIFF
optional stop_at = 7
Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
string stop_at_mark = 8
Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
message
cloud_sql_resources.proto:504Used in:
string cert_path = 1
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.
string pvk_path = 2
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.
string pvk_password = 3
Password that encrypts the private key
message
cloud_sql_resources.proto:479Used in:
string table = 1
The table to which CSV data is imported.
repeated string columns = 2
The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
string escape_character = 4
Specifies the character that should appear before a data character that needs to be escaped.
string quote_character = 5
Specifies the quoting character to be used when a data value is quoted.
string fields_terminated_by = 6
Specifies the character that separates columns within each row (line) of the file.
string lines_terminated_by = 8
This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
message
cloud_sql_resources.proto:453Used in:
optional threads = 1
Optional. The number of threads to use for parallel import.
optional parallel = 2
Optional. Whether or not the import should be parallel.
optional postgres_import_options = 3
Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
message
cloud_sql_resources.proto:454Used in:
optional clean = 1
Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
optional if_exists = 2
Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
message
cloud_sql_resources.proto:799Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration.
Used in:
bool query_insights_enabled = 1
Whether Query Insights feature is enabled.
bool record_client_address = 2
Whether Query Insights will record client address when enabled.
bool record_application_tags = 3
Whether Query Insights will record application tags from query when enabled.
optional query_string_length = 4
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.
optional query_plans_per_minute = 5
Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.
message
cloud_sql_resources.proto:254Reference to another Cloud SQL instance.
Used in:
string name = 1
The name of the Cloud SQL instance being referenced. This does not include the project ID.
string region = 2
The region of the Cloud SQL instance being referenced.
string project = 3
The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it.
message
cloud_sql_instances.proto:898Request to acquire a lease for SSRS.
Used in:
optional acquire_ssrs_lease_context = 1
Contains details about the acquire SSRS lease operation.
message
cloud_sql_instances.proto:807Database instance clone request.
Used in:
optional clone_context = 1
Contains details about the clone operation.
message
cloud_sql_instances.proto:813Database demote primary instance request.
Used in:
optional demote_master_context = 1
Contains details about the demoteMaster operation.
message
cloud_sql_instances.proto:820This request is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.
Used in:
optional demote_context = 1
Required. Contains details about the demote operation.
message
cloud_sql_instances.proto:826Database instance export request.
Used in:
optional export_context = 1
Contains details about the export operation.
message
cloud_sql_instances.proto:832Instance failover request.
Used in:
optional failover_context = 1
Failover Context.
message
cloud_sql_instances.proto:847Database instance import request.
Used in:
optional import_context = 1
Contains details about the import operation.
message
cloud_sql_instances.proto:645Database Instance reencrypt request.
Used in:
optional backup_reencryption_config = 1
Configuration specific to backup re-encryption
message
cloud_sql_instances.proto:880Database instance restore backup request.
Used in:
optional restore_backup_context = 1
Parameters required to perform the restore backup operation.
message
cloud_sql_instances.proto:886Rotate server CA request.
Used in:
optional rotate_server_ca_context = 1
Contains details about the rotate server CA operation.
message
cloud_sql_instances.proto:892Instance truncate log request.
Used in:
optional truncate_log_context = 1
Contains details about the truncate log operation.
message
cloud_sql_resources.proto:600IP Management configuration.
Used in:
optional ipv4_enabled = 1
Whether the instance is assigned a public IP 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 require_ssl = 3
Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag.
repeated authorized_networks = 4
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: `157.197.200.0/24`).
string allocated_ip_range = 6
The name of the allocated ip range for the private ip Cloud SQL 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](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.`
optional enable_private_path_for_google_cloud_services = 7
Controls connectivity to private IP instances from Google services, such as BigQuery.
IpConfiguration.SslMode ssl_mode = 8
Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections.
optional psc_config = 9
PSC settings for this instance.
optional IpConfiguration.CaMode server_ca_mode = 10
Specify what type of CA is used for the server certificate.
Various Certificate Authority (CA) modes for certificate signing.
Used in:
CA_MODE_UNSPECIFIED = 0
CA mode is unknown.
GOOGLE_MANAGED_INTERNAL_CA = 1
Google-managed self-signed internal CA.
GOOGLE_MANAGED_CAS_CA = 2
Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS).
The SSL options for database connections.
Used in:
SSL_MODE_UNSPECIFIED = 0
The SSL mode is unknown.
ALLOW_UNENCRYPTED_AND_ENCRYPTED = 1
Allow non-SSL/non-TLS and SSL/TLS connections. For SSL connections to MySQL and PostgreSQL, the client certificate isn't verified. When this value is used, the legacy `require_ssl` flag must be false or cleared to avoid a conflict between the values of the two flags.
ENCRYPTED_ONLY = 2
Only allow connections encrypted with SSL/TLS. For SSL connections to MySQL and PostgreSQL, the client certificate isn't verified. When this value is used, the legacy `require_ssl` flag must be false or cleared to avoid a conflict between the values of the two flags.
TRUSTED_CLIENT_CERTIFICATE_REQUIRED = 3
Only allow connections encrypted with SSL/TLS and with valid client certificates. When this value is used, the legacy `require_ssl` flag must be true or cleared to avoid the conflict between values of two flags. PostgreSQL clients or users that connect using IAM database authentication must use either the [Cloud SQL Auth Proxy](https://cloud.google.com/sql/docs/postgres/connect-auth-proxy) or [Cloud SQL Connectors](https://cloud.google.com/sql/docs/postgres/connect-connectors) to enforce client identity verification. Only applicable to MySQL and PostgreSQL. Not applicable to SQL Server.
message
cloud_sql_resources.proto:883Database instance IP mapping
Used in: ,
SqlIpAddressType type = 1
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.
string ip_address = 2
The IP address assigned.
optional time_to_retire = 3
The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired.
message
cloud_sql_resources.proto:739Preferred 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.
Used in:
string follow_gae_application = 1
The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance.
string zone = 2
The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance.
string secondary_zone = 4
The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). To disable this field, set it to 'no_secondary_zone'.
string kind = 3
This is always `sql#locationPreference`.
message
cloud_sql_resources.proto:759Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes.
Used in:
optional hour = 1
Hour of day - 0 to 23. Specify in the UTC time zone.
optional day = 2
Day of week - `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, or `SUNDAY`. Specify in the UTC time zone. Returned in output as an integer, 1 to 7, where `1` equals Monday.
SqlUpdateTrack update_track = 3
Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance).
string kind = 4
This is always `sql#maintenanceWindow`.
message
cloud_sql_resources.proto:822Read-replica configuration specific to MySQL databases.
Used in:
string dump_file_path = 1
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.
string username = 2
The username for the replication connection.
string password = 3
The password for the replication connection.
optional connect_retry_interval = 4
Seconds to wait between connect retries. MySQL's default is 60 seconds.
optional master_heartbeat_period = 5
Interval in milliseconds between replication heartbeats.
string ca_certificate = 6
PEM representation of the trusted CA's x509 certificate.
string client_certificate = 7
PEM representation of the replica's x509 certificate.
string client_key = 8
PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
string ssl_cipher = 9
A list of permissible ciphers to use for SSL encryption.
optional verify_server_certificate = 10
Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.
string kind = 11
This is always `sql#mysqlReplicaConfiguration`.
message
cloud_sql_resources.proto:237MySQL-specific external server sync settings.
Used in: ,
repeated initial_sync_flags = 1
Flags to use for the initial dump.
message
cloud_sql_instances.proto:1654On-premises instance configuration.
Used in:
string host_port = 1
The host and port of the on-premises instance in host:port format
string kind = 2
This is always `sql#onPremisesConfiguration`.
string username = 3
The username for connecting to on-premises instance.
string password = 4
The password for connecting to on-premises instance.
string ca_certificate = 5
PEM representation of the trusted CA's x509 certificate.
string client_certificate = 6
PEM representation of the replica's x509 certificate.
string client_key = 7
PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
string dump_file_path = 8
The dump file to create the Cloud SQL replica.
optional source_instance = 15
The reference to Cloud SQL instance if the source is Cloud SQL.
message
cloud_sql_resources.proto:903An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
Used as response type in: SqlBackupRunsService.Delete, SqlBackupRunsService.Insert, SqlDatabasesService.Delete, SqlDatabasesService.Insert, SqlDatabasesService.Patch, SqlDatabasesService.Update, SqlInstancesService.AddServerCa, SqlInstancesService.Clone, SqlInstancesService.Delete, SqlInstancesService.Demote, SqlInstancesService.DemoteMaster, SqlInstancesService.Export, SqlInstancesService.Failover, SqlInstancesService.Import, SqlInstancesService.Insert, SqlInstancesService.Patch, SqlInstancesService.PerformDiskShrink, SqlInstancesService.PromoteReplica, SqlInstancesService.Reencrypt, SqlInstancesService.RescheduleMaintenance, SqlInstancesService.ResetReplicaSize, SqlInstancesService.ResetSslConfig, SqlInstancesService.Restart, SqlInstancesService.RestoreBackup, SqlInstancesService.RotateServerCa, SqlInstancesService.StartExternalSync, SqlInstancesService.StartReplica, SqlInstancesService.StopReplica, SqlInstancesService.Switchover, SqlInstancesService.TruncateLog, SqlInstancesService.Update, SqlOperationsService.Get, SqlSslCertsService.Delete, SqlUsersService.Delete, SqlUsersService.Insert, SqlUsersService.Update
Used as field type in: ,
string kind = 1
This is always `sql#operation`.
string target_link = 2
Operation.SqlOperationStatus status = 3
The status of an operation.
string user = 4
The email address of the user who initiated this operation.
optional insert_time = 5
The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
optional start_time = 6
The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
optional end_time = 7
The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
optional error = 8
If errors occurred during processing of this operation, this field will be populated.
optional api_warning = 19
An Admin API warning message.
Operation.SqlOperationType operation_type = 9
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`
optional import_context = 10
The context for import operation, if applicable.
optional export_context = 11
The context for export operation, if applicable.
optional backup_context = 17
The context for backup operation, if applicable.
string name = 12
An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
string target_id = 13
Name of the database instance related to this operation.
string self_link = 14
The URI of this resource.
string target_project = 15
The project ID of the target instance related to this operation.
optional acquire_ssrs_lease_context = 20
The context for acquire SSRS lease operation, if applicable.
The status of an operation.
Used in:
SQL_OPERATION_STATUS_UNSPECIFIED = 0
The state of the operation is unknown.
PENDING = 1
The operation has been queued, but has not started yet.
RUNNING = 2
The operation is running.
DONE = 3
The operation completed.
The type of Cloud SQL operation.
Used in:
SQL_OPERATION_TYPE_UNSPECIFIED = 0
Unknown operation type.
IMPORT = 1
Imports data into a Cloud SQL instance.
EXPORT = 2
Exports data from a Cloud SQL instance to a Cloud Storage bucket.
CREATE = 3
Creates a new Cloud SQL instance.
UPDATE = 4
Updates the settings of a Cloud SQL instance.
DELETE = 5
Deletes a Cloud SQL instance.
RESTART = 6
Restarts the Cloud SQL instance.
BACKUP = 7
SNAPSHOT = 8
BACKUP_VOLUME = 9
Performs instance backup.
DELETE_VOLUME = 10
Deletes an instance backup.
RESTORE_VOLUME = 11
Restores an instance backup.
INJECT_USER = 12
Injects a privileged user in mysql for MOB instances.
CLONE = 14
Clones a Cloud SQL instance.
STOP_REPLICA = 15
Stops replication on a Cloud SQL read replica instance.
START_REPLICA = 16
Starts replication on a Cloud SQL read replica instance.
PROMOTE_REPLICA = 17
Promotes a Cloud SQL replica instance.
CREATE_REPLICA = 18
Creates a Cloud SQL replica instance.
CREATE_USER = 19
Creates a new user in a Cloud SQL instance.
DELETE_USER = 20
Deletes a user from a Cloud SQL instance.
UPDATE_USER = 21
Updates an existing user in a Cloud SQL instance.
CREATE_DATABASE = 22
Creates a database in the Cloud SQL instance.
DELETE_DATABASE = 23
Deletes a database in the Cloud SQL instance.
UPDATE_DATABASE = 24
Updates a database in the Cloud SQL instance.
FAILOVER = 25
Performs failover of an HA-enabled Cloud SQL failover replica.
DELETE_BACKUP = 26
Deletes the backup taken by a backup run.
RECREATE_REPLICA = 27
TRUNCATE_LOG = 28
Truncates a general or slow log table in MySQL.
DEMOTE_MASTER = 29
Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.
MAINTENANCE = 30
Indicates that the instance is currently in maintenance. Maintenance typically causes the instance to be unavailable for 1-3 minutes.
ENABLE_PRIVATE_IP = 31
This field is deprecated, and will be removed in future version of API.
DEFER_MAINTENANCE = 32
CREATE_CLONE = 33
Creates clone instance.
RESCHEDULE_MAINTENANCE = 34
Reschedule maintenance to another time.
START_EXTERNAL_SYNC = 35
Starts external sync of a Cloud SQL EM replica to an external primary instance.
LOG_CLEANUP = 36
Recovers logs from an instance's old data disk.
AUTO_RESTART = 37
Performs auto-restart of an HA-enabled Cloud SQL database for auto recovery.
REENCRYPT = 38
Re-encrypts CMEK instances with latest key version.
SWITCHOVER = 39
Switches the roles of the primary and replica pair. The target instance should be the replica.
ACQUIRE_SSRS_LEASE = 42
Acquire a lease for the setup of SQL Server Reporting Services (SSRS).
RELEASE_SSRS_LEASE = 43
Release a lease for the setup of SQL Server Reporting Services (SSRS).
RECONFIGURE_OLD_PRIMARY = 44
Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica.
CLUSTER_MAINTENANCE = 45
Indicates that the instance, its read replicas, and its cascading replicas are in maintenance. Maintenance typically gets initiated on groups of replicas first, followed by the primary instance. For each instance, maintenance typically causes the instance to be unavailable for 1-3 minutes.
SELF_SERVICE_MAINTENANCE = 46
Indicates that the instance (and any of its replicas) are currently in maintenance. This is initiated as a self-service request by using SSM. Maintenance typically causes the instance to be unavailable for 1-3 minutes.
SWITCHOVER_TO_REPLICA = 47
Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance.
MAJOR_VERSION_UPGRADE = 48
Updates the major version of a Cloud SQL instance.
message
cloud_sql_resources.proto:1150Database instance operation error.
Used in: ,
string kind = 1
This is always `sql#operationError`.
string code = 2
Identifies the specific error that occurred.
string message = 3
Additional information about the error encountered.
message
cloud_sql_resources.proto:1162Database instance operation errors list wrapper.
Used in:
string kind = 1
This is always `sql#operationErrors`.
repeated errors = 2
The list of errors encountered while processing this operation.
message
cloud_sql_users.proto:159Read-only password status.
Used in:
bool locked = 1
If true, user does not have login privileges.
optional password_expiration_time = 2
The expiration time of the current password.
message
cloud_sql_resources.proto:1171Database instance local user password validation policy
Used in:
optional min_length = 1
Minimum number of characters allowed.
PasswordValidationPolicy.Complexity complexity = 2
The complexity of the password.
optional reuse_interval = 3
Number of previous passwords that cannot be reused.
optional disallow_username_substring = 4
Disallow username as a part of the password.
optional password_change_interval = 5
Minimum interval after which the password can be changed. This flag is only supported for PostgreSQL.
optional enable_password_policy = 6
Whether the password policy is enabled or not.
optional disallow_compromised_credentials = 7
This field is deprecated and will be removed in a future version of the API.
The complexity choices of the password.
Used in:
COMPLEXITY_UNSPECIFIED = 0
Complexity check is not specified.
COMPLEXITY_DEFAULT = 1
A combination of lowercase, uppercase, numeric, and non-alphanumeric characters.
message
cloud_sql_resources.proto:164Perform disk shrink context.
Used in:
int64 target_size_gb = 1
The target disk shrink size in GigaBytes.
message
cloud_sql_resources.proto:721PSC settings for a Cloud SQL instance.
Used in:
optional bool psc_enabled = 1
Whether PSC connectivity is enabled for this instance.
repeated string allowed_consumer_projects = 2
Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
message
cloud_sql_instances.proto:1685Read-replica configuration for connecting to the primary instance.
Used in:
string kind = 1
This is always `sql#replicaConfiguration`.
optional mysql_replica_configuration = 2
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.
optional failover_target = 3
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.
optional cascadable_replica = 5
Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.
message
cloud_sql_instances.proto:1320A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
Used in:
string psa_write_endpoint = 1
Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.
string failover_dr_replica_name = 2
Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.
bool dr_replica = 4
Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.
message
cloud_sql_instances.proto:1438Database instance restore from backup context. Backup context contains source instance id and project id.
Used in:
string kind = 1
This is always `sql#restoreBackupContext`.
int64 backup_run_id = 2
The ID of the backup run to restore from.
string instance_id = 3
The ID of the instance that the backup was taken from.
string project = 4
The full project ID of the source instance.
message
cloud_sql_instances.proto:1453Instance rotate server CA context.
Used in:
string kind = 1
This is always `sql#rotateServerCaContext`.
string next_version = 2
The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server CA version.
message
cloud_sql_resources.proto:1214Database instance settings.
Used in:
optional settings_version = 1
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.
repeated string authorized_gae_applications = 2
The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
string tier = 3
The tier (or machine type) for this instance, for example `db-custom-1-3840`. WARNING: Changing this restarts the instance.
string kind = 4
This is always `sql#settings`.
map<string, string> user_labels = 5
User-provided labels, represented as a dictionary where each label is a single key value pair.
SqlAvailabilityType availability_type = 6
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](https://cloud.google.com/sql/docs/mysql/high-availability).
SqlPricingPlan pricing_plan = 7
The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
SqlReplicationType replication_type = 8
The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
optional storage_auto_resize_limit = 9
The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
Settings.SqlActivationPolicy activation_policy = 10
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 ip_configuration = 11
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.
optional storage_auto_resize = 12
Configuration to increase storage size automatically. The default value is true.
optional location_preference = 13
The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.
repeated database_flags = 14
The database flags passed to the instance at startup.
SqlDataDiskType data_disk_type = 15
The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not used for First Generation instances.
optional maintenance_window = 16
The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
optional backup_configuration = 17
The daily backup configuration for the instance.
optional database_replication_enabled = 18
Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
optional crash_safe_replication_enabled = 19
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.
optional data_disk_size_gb = 20
The size of data disk, in GB. The data disk size minimum is 10GB.
optional active_directory_config = 22
Active Directory configuration, relevant only for Cloud SQL for SQL Server.
string collation = 23
The name of server Instance collation.
repeated deny_maintenance_periods = 24
Deny maintenance periods
optional insights_config = 25
Insights configuration, for now relevant only for Postgres.
optional password_validation_policy = 27
The local user password validation policy of the instance.
optional sql_server_audit_config = 29
SQL Server specific audit configuration.
Settings.Edition edition = 38
Optional. The edition of the instance.
Settings.ConnectorEnforcement connector_enforcement = 32
Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
optional deletion_protection_enabled = 33
Configuration to protect against accidental instance deletion.
string time_zone = 34
Server timezone, relevant only for Cloud SQL for SQL Server.
optional advanced_machine_features = 35
Specifies advanced machine configuration for the instances relevant only for SQL Server.
optional data_cache_config = 37
Configuration for data cache.
optional enable_google_ml_integration = 40
Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances.
optional enable_dataplex_integration = 41
Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated.
The options for enforcing Cloud SQL connectors in the instance.
Used in:
CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0
The requirement for Cloud SQL connectors is unknown.
NOT_REQUIRED = 1
Do not require Cloud SQL connectors.
REQUIRED = 2
Require all connections to use Cloud SQL connectors, including the Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors. Note: This disables all existing authorized networks.
The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
Used in:
EDITION_UNSPECIFIED = 0
The instance did not specify the edition.
ENTERPRISE = 2
The instance is an enterprise edition.
ENTERPRISE_PLUS = 3
The instance is an Enterprise Plus edition.
Specifies when the instance is activated.
Used in:
SQL_ACTIVATION_POLICY_UNSPECIFIED = 0
Unknown activation plan.
ALWAYS = 1
The instance is always up and running.
NEVER = 2
The instance never starts.
ON_DEMAND = 3
The instance starts upon receiving requests.
message
cloud_sql_resources.proto:1462Active Directory configuration, relevant only for Cloud SQL for SQL Server.
Used in:
string kind = 1
This is always sql#activeDirectoryConfig.
string domain = 2
The name of the domain (e.g., mydomain.com).
The availability type of the given Cloud SQL instance.
Used in:
SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0
This is an unknown Availability type.
ZONAL = 1
Zonal available instance.
REGIONAL = 2
Regional available instance.
Used in: ,
SQL_BACKEND_TYPE_UNSPECIFIED = 0
This is an unknown backend type for instance.
FIRST_GEN = 1
V1 speckle instance.
SECOND_GEN = 2
V2 speckle instance.
EXTERNAL = 3
On premises instance.
Defines the supported backup kinds.
Used in:
SQL_BACKUP_KIND_UNSPECIFIED = 0
This is an unknown BackupKind.
SNAPSHOT = 1
The snapshot based backups
PHYSICAL = 2
Physical backups
The status of a backup run.
Used in:
SQL_BACKUP_RUN_STATUS_UNSPECIFIED = 0
The status of the run is unknown.
ENQUEUED = 1
The backup operation was enqueued.
OVERDUE = 2
The backup is overdue across a given backup window. Indicates a problem. Example: Long-running operation in progress during the whole window.
RUNNING = 3
The backup is in progress.
FAILED = 4
The backup failed.
SUCCESSFUL = 5
The backup was successful.
SKIPPED = 6
The backup was skipped (without problems) for a given backup window. Example: Instance was idle.
DELETION_PENDING = 7
The backup is about to be deleted.
DELETION_FAILED = 8
The backup deletion failed.
DELETED = 9
The backup has been deleted.
Type of backup (i.e. automated, on demand, etc).
Used in:
SQL_BACKUP_RUN_TYPE_UNSPECIFIED = 0
This is an unknown BackupRun type.
AUTOMATED = 1
The backup schedule automatically triggers a backup.
ON_DEMAND = 2
The user manually triggers a backup.
The type of disk that is used for a v2 instance to use.
Used in:
SQL_DATA_DISK_TYPE_UNSPECIFIED = 0
This is an unknown data disk type.
PD_SSD = 1
An SSD data disk.
PD_HDD = 2
An HDD data disk.
OBSOLETE_LOCAL_SSD = 3
This field is deprecated and will be removed from a future version of the API.
The database engine type and version.
Used in: , ,
SQL_DATABASE_VERSION_UNSPECIFIED = 0
This is an unknown database version.
MYSQL_5_1 = 2
The database version is MySQL 5.1.
MYSQL_5_5 = 3
The database version is MySQL 5.5.
MYSQL_5_6 = 5
The database version is MySQL 5.6.
MYSQL_5_7 = 6
The database version is MySQL 5.7.
SQLSERVER_2017_STANDARD = 11
The database version is SQL Server 2017 Standard.
SQLSERVER_2017_ENTERPRISE = 14
The database version is SQL Server 2017 Enterprise.
SQLSERVER_2017_EXPRESS = 15
The database version is SQL Server 2017 Express.
SQLSERVER_2017_WEB = 16
The database version is SQL Server 2017 Web.
POSTGRES_9_6 = 9
The database version is PostgreSQL 9.6.
POSTGRES_10 = 18
The database version is PostgreSQL 10.
POSTGRES_11 = 10
The database version is PostgreSQL 11.
POSTGRES_12 = 19
The database version is PostgreSQL 12.
POSTGRES_13 = 23
The database version is PostgreSQL 13.
POSTGRES_14 = 110
The database version is PostgreSQL 14.
POSTGRES_15 = 172
The database version is PostgreSQL 15.
POSTGRES_16 = 272
The database version is PostgreSQL 16.
MYSQL_8_0 = 20
The database version is MySQL 8.
MYSQL_8_0_18 = 41
The database major version is MySQL 8.0 and the minor version is 18.
MYSQL_8_0_26 = 85
The database major version is MySQL 8.0 and the minor version is 26.
MYSQL_8_0_27 = 111
The database major version is MySQL 8.0 and the minor version is 27.
MYSQL_8_0_28 = 132
The database major version is MySQL 8.0 and the minor version is 28.
MYSQL_8_0_29 = 148
The database major version is MySQL 8.0 and the minor version is 29.
MYSQL_8_0_30 = 174
The database major version is MySQL 8.0 and the minor version is 30.
MYSQL_8_0_31 = 197
The database major version is MySQL 8.0 and the minor version is 31.
MYSQL_8_0_32 = 213
The database major version is MySQL 8.0 and the minor version is 32.
MYSQL_8_0_33 = 238
The database major version is MySQL 8.0 and the minor version is 33.
MYSQL_8_0_34 = 239
The database major version is MySQL 8.0 and the minor version is 34.
MYSQL_8_0_35 = 240
The database major version is MySQL 8.0 and the minor version is 35.
MYSQL_8_0_36 = 241
The database major version is MySQL 8.0 and the minor version is 36.
MYSQL_8_0_37 = 355
The database major version is MySQL 8.0 and the minor version is 37.
MYSQL_8_0_38 = 356
The database major version is MySQL 8.0 and the minor version is 38.
MYSQL_8_0_39 = 357
The database major version is MySQL 8.0 and the minor version is 39.
MYSQL_8_0_40 = 358
The database major version is MySQL 8.0 and the minor version is 40.
MYSQL_8_4 = 398
The database version is MySQL 8.4.
MYSQL_8_4_0 = 399
The database version is MySQL 8.4 and the patch version is 0.
SQLSERVER_2019_STANDARD = 26
The database version is SQL Server 2019 Standard.
SQLSERVER_2019_ENTERPRISE = 27
The database version is SQL Server 2019 Enterprise.
SQLSERVER_2019_EXPRESS = 28
The database version is SQL Server 2019 Express.
SQLSERVER_2019_WEB = 29
The database version is SQL Server 2019 Web.
SQLSERVER_2022_STANDARD = 199
The database version is SQL Server 2022 Standard.
SQLSERVER_2022_ENTERPRISE = 200
The database version is SQL Server 2022 Enterprise.
SQLSERVER_2022_EXPRESS = 201
The database version is SQL Server 2022 Express.
SQLSERVER_2022_WEB = 202
The database version is SQL Server 2022 Web.
message
cloud_sql_databases.proto:134Database update request.
Used as request type in: SqlDatabasesService.Patch, SqlDatabasesService.Update
string database = 1
Name of the database to be updated in the instance.
string instance = 2
Database instance ID. This does not include the project ID.
string project = 3
Project ID of the project that contains the instance.
optional body = 100
message
cloud_sql_instances.proto:1473External primary instance migration setting error/warning.
Used in:
string kind = 1
Can be `sql#externalSyncSettingError` or `sql#externalSyncSettingWarning`.
SqlExternalSyncSettingError.SqlExternalSyncSettingErrorType type = 2
Identifies the specific error that occurred.
string detail = 3
Additional information about the error encountered.
Used in:
SQL_EXTERNAL_SYNC_SETTING_ERROR_TYPE_UNSPECIFIED = 0
CONNECTION_FAILURE = 1
BINLOG_NOT_ENABLED = 2
INCOMPATIBLE_DATABASE_VERSION = 3
REPLICA_ALREADY_SETUP = 4
INSUFFICIENT_PRIVILEGE = 5
The replication user is missing privileges that are required.
UNSUPPORTED_MIGRATION_TYPE = 6
Unsupported migration type.
NO_PGLOGICAL_INSTALLED = 7
No pglogical extension installed on databases, applicable for postgres.
PGLOGICAL_NODE_ALREADY_EXISTS = 8
pglogical node already exists on databases, applicable for postgres.
INVALID_WAL_LEVEL = 9
The value of parameter wal_level is not set to logical.
INVALID_SHARED_PRELOAD_LIBRARY = 10
The value of parameter shared_preload_libraries does not include pglogical.
INSUFFICIENT_MAX_REPLICATION_SLOTS = 11
The value of parameter max_replication_slots is not sufficient.
INSUFFICIENT_MAX_WAL_SENDERS = 12
The value of parameter max_wal_senders is not sufficient.
INSUFFICIENT_MAX_WORKER_PROCESSES = 13
The value of parameter max_worker_processes is not sufficient.
UNSUPPORTED_EXTENSIONS = 14
Extensions installed are either not supported or having unsupported versions.
INVALID_RDS_LOGICAL_REPLICATION = 15
The value of parameter rds.logical_replication is not set to 1.
INVALID_LOGGING_SETUP = 16
The primary instance logging setup doesn't allow EM sync.
INVALID_DB_PARAM = 17
The primary instance database parameter setup doesn't allow EM sync.
UNSUPPORTED_GTID_MODE = 18
The gtid_mode is not supported, applicable for MySQL.
SQLSERVER_AGENT_NOT_RUNNING = 19
SQL Server Agent is not running.
UNSUPPORTED_TABLE_DEFINITION = 20
The table definition is not support due to missing primary key or replica identity, applicable for postgres.
UNSUPPORTED_DEFINER = 21
The customer has a definer that will break EM setup.
SQLSERVER_SERVERNAME_MISMATCH = 22
SQL Server @@SERVERNAME does not match actual host name.
PRIMARY_ALREADY_SETUP = 23
The primary instance has been setup and will fail the setup.
UNSUPPORTED_BINLOG_FORMAT = 24
The primary instance has unsupported binary log format.
BINLOG_RETENTION_SETTING = 25
The primary instance's binary log retention setting.
UNSUPPORTED_STORAGE_ENGINE = 26
The primary instance has tables with unsupported storage engine.
LIMITED_SUPPORT_TABLES = 27
Source has tables with limited support eg: PostgreSQL tables without primary keys.
EXISTING_DATA_IN_REPLICA = 28
The replica instance contains existing data.
MISSING_OPTIONAL_PRIVILEGES = 29
The replication user is missing privileges that are optional.
RISKY_BACKUP_ADMIN_PRIVILEGE = 30
Additional BACKUP_ADMIN privilege is granted to the replication user which may lock source MySQL 8 instance for DDLs during initial sync.
INSUFFICIENT_GCS_PERMISSIONS = 31
The Cloud Storage bucket is missing necessary permissions.
INVALID_FILE_INFO = 32
The Cloud Storage bucket has an error in the file or contains invalid file information.
UNSUPPORTED_DATABASE_SETTINGS = 33
The source instance has unsupported database settings for migration.
MYSQL_PARALLEL_IMPORT_INSUFFICIENT_PRIVILEGE = 34
The replication user is missing parallel import specific privileges. (e.g. LOCK TABLES) for MySQL.
LOCAL_INFILE_OFF = 35
The global variable local_infile is off on external server replica.
TURN_ON_PITR_AFTER_PROMOTE = 36
This code instructs customers to turn on point-in-time recovery manually for the instance after promoting the Cloud SQL for PostgreSQL instance.
INCOMPATIBLE_DATABASE_MINOR_VERSION = 37
The minor version of replica database is incompatible with the source.
SOURCE_MAX_SUBSCRIPTIONS = 38
This warning message indicates that Cloud SQL uses the maximum number of subscriptions to migrate data from the source to the destination.
UNABLE_TO_VERIFY_DEFINERS = 39
Unable to verify definers on the source for MySQL.
SUBSCRIPTION_CALCULATION_STATUS = 40
If a time out occurs while the subscription counts are calculated, then this value is set to 1. Otherwise, this value is set to 2.
PG_SUBSCRIPTION_COUNT = 41
Count of subscriptions needed to sync source data for PostgreSQL database.
PG_SYNC_PARALLEL_LEVEL = 42
Final parallel level that is used to do migration.
INSUFFICIENT_DISK_SIZE = 43
The disk size of the replica instance is smaller than the data size of the source instance.
INSUFFICIENT_MACHINE_TIER = 44
The data size of the source instance is greater than 1 TB, the number of cores of the replica instance is less than 8, and the memory of the replica is less than 32 GB.
UNSUPPORTED_EXTENSIONS_NOT_MIGRATED = 45
The warning message indicates the unsupported extensions will not be migrated to the destination.
EXTENSIONS_NOT_MIGRATED = 46
The warning message indicates the pg_cron extension and settings will not be migrated to the destination.
PG_CRON_FLAG_ENABLED_IN_REPLICA = 47
The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration.
EXTENSIONS_NOT_ENABLED_IN_REPLICA = 48
This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance.
UNSUPPORTED_COLUMNS = 49
The source database has generated columns that can't be migrated. Please change them to regular columns before migration.
Used in: ,
SQL_FILE_TYPE_UNSPECIFIED = 0
Unknown file type.
SQL = 1
File containing SQL statements.
CSV = 2
File in CSV format.
BAK = 4
Used in:
SQL_FLAG_TYPE_UNSPECIFIED = 0
This is an unknown flag type.
BOOLEAN = 1
Boolean type flag.
STRING = 2
String type flag.
INTEGER = 3
Integer type flag.
NONE = 4
Flag type used for a server startup option.
MYSQL_TIMEZONE_OFFSET = 5
Type introduced specially for MySQL TimeZone offset. Accept a string value with the format [-12:59, 13:00].
FLOAT = 6
Float type flag.
REPEATED_STRING = 7
Comma-separated list of the strings in a SqlFlagType enum.
Used in:
SQL_INSTANCE_TYPE_UNSPECIFIED = 0
This is an unknown Cloud SQL instance type.
CLOUD_SQL_INSTANCE = 1
A regular Cloud SQL instance that is not replicating from a primary instance.
ON_PREMISES_INSTANCE = 2
An instance running on the customer's premises that is not managed by Cloud SQL.
READ_REPLICA_INSTANCE = 3
A Cloud SQL instance acting as a read-replica.
message
cloud_sql_instances.proto:1357Reschedule options for maintenance windows.
Used in:
optional reschedule = 3
Required. The type of the reschedule the user wants.
message
cloud_sql_instances.proto:1372Used in:
RescheduleType reschedule_type = 1
Required. The type of the reschedule.
optional schedule_time = 2
Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
Used in:
RESCHEDULE_TYPE_UNSPECIFIED = 0
IMMEDIATE = 1
Reschedules maintenance to happen now (within 5 minutes).
NEXT_AVAILABLE_WINDOW = 2
Reschedules maintenance to occur within one week from the originally scheduled day and time.
SPECIFIC_TIME = 3
Reschedules maintenance to a specific time and day.
Used in: ,
EXTERNAL_SYNC_MODE_UNSPECIFIED = 0
Unknown external sync mode, will be defaulted to ONLINE mode
ONLINE = 1
Online external sync will set up replication after initial data external sync
OFFLINE = 2
Offline external sync only dumps and loads a one-time snapshot of the primary instance's data
MigrationType determines whether the migration is a physical file-based migration or a logical dump file-based migration.
Used in: ,
MIGRATION_TYPE_UNSPECIFIED = 0
Default value is a logical dump file-based migration
LOGICAL = 1
Logical dump file-based migration
PHYSICAL = 2
Physical file-based migration
Used in:
SQL_IP_ADDRESS_TYPE_UNSPECIFIED = 0
This is an unknown IP address type.
PRIMARY = 1
IP address the customer is supposed to connect to. Usually this is the load balancer's IP address
OUTGOING = 2
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 = 3
Private IP used when using private IPs and network peering.
MIGRATED_1ST_GEN = 4
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.
The pricing plan for this instance.
Used in:
SQL_PRICING_PLAN_UNSPECIFIED = 0
This is an unknown pricing plan for this instance.
PACKAGE = 1
The instance is billed at a monthly flat rate.
PER_USE = 2
The instance is billed per usage.
Used in:
SQL_REPLICATION_TYPE_UNSPECIFIED = 0
This is an unknown replication type for a Cloud SQL instance.
SYNCHRONOUS = 1
The synchronous replication mode for First Generation instances. It is the default value.
ASYNCHRONOUS = 2
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.
message
cloud_sql_resources.proto:1471SQL Server specific audit configuration.
Used in:
string kind = 1
This is always sql#sqlServerAuditConfig
string bucket = 2
The name of the destination bucket (e.g., gs://mybucket).
optional retention_interval = 3
How long to keep generated audit files.
optional upload_interval = 4
How often to upload generated audit files.
message
cloud_sql_resources.proto:213Represents a Sql Server database on the Cloud SQL instance.
Used in:
int32 compatibility_level = 1
The version of SQL Server with which the database is to be made compatible
string recovery_model = 2
The recovery model of a SQL Server database
message
cloud_sql_users.proto:253Represents a Sql Server user on the Cloud SQL instance.
Used in:
bool disabled = 1
If the user has been disabled
repeated string server_roles = 2
The server roles for this user
The suspension reason of the database instance if the state is SUSPENDED.
Used in:
SQL_SUSPENSION_REASON_UNSPECIFIED = 0
This is an unknown suspension reason.
BILLING_ISSUE = 2
The instance is suspended due to billing issues (for example:, GCP account issue)
LEGAL_ISSUE = 3
The instance is suspended due to illegal content (for example:, child pornography, copyrighted material, etc.).
OPERATIONAL_ISSUE = 4
The instance is causing operational issues (for example:, causing the database to crash).
KMS_KEY_ISSUE = 5
The KMS key used by the instance is either revoked or denied access to
Used in:
SQL_UPDATE_TRACK_UNSPECIFIED = 0
This is an unknown maintenance timing preference.
canary = 1
For an instance with a scheduled maintenance window, this maintenance timing indicates that the maintenance update is scheduled 7 to 14 days after the notification is sent out. Also referred to as `Week 1` (Console) and `preview` (gcloud CLI).
stable = 2
For an instance with a scheduled maintenance window, this maintenance timing indicates that the maintenance update is scheduled 15 to 21 days after the notification is sent out. Also referred to as `Week 2` (Console) and `production` (gcloud CLI).
week5 = 3
For instance with a scheduled maintenance window, this maintenance timing indicates that the maintenance update is scheduled 35 to 42 days after the notification is sent out.
message
cloud_sql_resources.proto:1418SslCerts Resource
Used as response type in: SqlInstancesService.CreateEphemeral, SqlSslCertsService.Get
Used as field type in: , , , , , ,
string kind = 1
This is always `sql#sslCert`.
string cert_serial_number = 2
Serial number, as extracted from the certificate.
string cert = 3
PEM representation.
optional create_time = 4
The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`
string common_name = 5
User supplied name. Constrained to [a-zA-Z.-_ ]+.
optional expiration_time = 6
The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
string sha1_fingerprint = 7
Sha1 Fingerprint.
string instance = 8
Name of the database instance.
string self_link = 9
The URI of this resource.
message
cloud_sql_resources.proto:1452SslCertDetail.
Used in:
optional cert_info = 1
The public information about the cert.
string cert_private_key = 2
The private key for the client cert, in pem format. Keep private in order to protect your security.
message
cloud_sql_instances.proto:838SslCerts create ephemeral certificate request.
Used in:
string public_key = 1
PEM encoded public key to include in the signed certificate.
string access_token = 2
Access token to include in the signed certificate.
message
cloud_sql_ssl_certs.proto:113SslCerts insert request.
Used in:
string common_name = 1
User supplied name. Must be a distinct name from the other certificates for this instance.
message
cloud_sql_resources.proto:244Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.
Used in:
string name = 1
The name of the flag.
string value = 2
The value of the flag. This field must be omitted if the flag doesn't take a value.
message
cloud_sql_tiers.proto:62A Google Cloud SQL service tier resource.
Used in:
string tier = 1
An identifier for the machine type, for example, `db-custom-1-3840`. For related information, see [Pricing](/sql/pricing).
int64 RAM = 2
The maximum RAM usage of this tier in bytes.
string kind = 3
This is always `sql#tier`.
int64 Disk_Quota = 4
The maximum disk size of this tier in bytes.
repeated string region = 5
The applicable regions for this tier.
message
cloud_sql_instances.proto:1463Database Instance truncate log context.
Used in:
string kind = 1
This is always `sql#truncateLogContext`.
string log_type = 2
The type of log to truncate. Valid values are `MYSQL_GENERAL_TABLE` and `MYSQL_SLOW_TABLE`.
message
cloud_sql_users.proto:168A Cloud SQL user resource.
Used as response type in: SqlUsersService.Get
Used as field type in: , ,
string kind = 1
This is always `sql#user`.
string password = 2
The password for the user.
string etag = 3
This field is deprecated and will be removed from a future version of the API.
string name = 4
The name of the user in the Cloud SQL instance. Can be omitted for `update` because it is already specified in the URL.
string host = 5
Optional. The host 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. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
string instance = 6
The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL.
string project = 7
The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for `update` because it is already specified on the URL.
User.SqlUserType type = 8
The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
oneof user_details
User details for specific database type
sqlserver_user_details = 9
optional password_policy = 12
User level password validation policy.
optional User.DualPasswordType dual_password_type = 13
Dual password status for the user.
The type of retained password.
Used in:
DUAL_PASSWORD_TYPE_UNSPECIFIED = 0
The default value.
NO_MODIFY_DUAL_PASSWORD = 1
Do not update the user's dual password status.
NO_DUAL_PASSWORD = 2
No dual password usable for connecting using this user.
DUAL_PASSWORD = 3
Dual password usable for connecting using this user.
The user type.
Used in:
BUILT_IN = 0
The database's built-in user type.
CLOUD_IAM_USER = 1
Cloud IAM user.
CLOUD_IAM_SERVICE_ACCOUNT = 2
Cloud IAM service account.
CLOUD_IAM_GROUP = 3
Cloud IAM group non-login user.
CLOUD_IAM_GROUP_USER = 4
Cloud IAM group login user.
CLOUD_IAM_GROUP_SERVICE_ACCOUNT = 5
Cloud IAM group login service account.
message
cloud_sql_users.proto:140User level password validation policy.
Used in:
int32 allowed_failed_attempts = 1
Number of failed login attempts allowed before user get locked.
optional password_expiration_duration = 2
Expiration duration after password is updated.
bool enable_failed_attempts_check = 3
If true, failed login attempts check will be enabled.
optional status = 4
Output only. Read-only password status.
bool enable_password_verification = 5
If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.