1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="sqladmin_v1.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1.instances.html">instances</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#addServerCa">addServerCa(project, instance, x__xgafv=None)</a></code></p> 79<p class="firstline">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.</p> 80<p class="toc_element"> 81 <code><a href="#clone">clone(project, instance, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.</p> 83<p class="toc_element"> 84 <code><a href="#close">close()</a></code></p> 85<p class="firstline">Close httplib2 connections.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(project, instance, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes a Cloud SQL instance.</p> 89<p class="toc_element"> 90 <code><a href="#demoteMaster">demoteMaster(project, instance, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.</p> 92<p class="toc_element"> 93 <code><a href="#export">export(project, instance, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.</p> 95<p class="toc_element"> 96 <code><a href="#failover">failover(project, instance, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">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.</p> 98<p class="toc_element"> 99 <code><a href="#get">get(project, instance, x__xgafv=None)</a></code></p> 100<p class="firstline">Retrieves a resource containing information about a Cloud SQL instance.</p> 101<p class="toc_element"> 102 <code><a href="#import_">import_(project, instance, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.</p> 104<p class="toc_element"> 105 <code><a href="#insert">insert(project, body=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Creates a new Cloud SQL instance.</p> 107<p class="toc_element"> 108 <code><a href="#list">list(project, filter=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Lists instances under a given project.</p> 110<p class="toc_element"> 111 <code><a href="#listServerCas">listServerCas(project, instance, x__xgafv=None)</a></code></p> 112<p class="firstline">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.</p> 113<p class="toc_element"> 114 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 115<p class="firstline">Retrieves the next page of results.</p> 116<p class="toc_element"> 117 <code><a href="#patch">patch(project, instance, body=None, x__xgafv=None)</a></code></p> 118<p class="firstline">Updates settings of a Cloud SQL instance. This method supports patch semantics.</p> 119<p class="toc_element"> 120 <code><a href="#promoteReplica">promoteReplica(project, instance, x__xgafv=None)</a></code></p> 121<p class="firstline">Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart.</p> 122<p class="toc_element"> 123 <code><a href="#resetSslConfig">resetSslConfig(project, instance, x__xgafv=None)</a></code></p> 124<p class="firstline">Deletes all client certificates and generates a new server SSL certificate for the instance.</p> 125<p class="toc_element"> 126 <code><a href="#restart">restart(project, instance, x__xgafv=None)</a></code></p> 127<p class="firstline">Restarts a Cloud SQL instance.</p> 128<p class="toc_element"> 129 <code><a href="#restoreBackup">restoreBackup(project, instance, body=None, x__xgafv=None)</a></code></p> 130<p class="firstline">Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.</p> 131<p class="toc_element"> 132 <code><a href="#rotateServerCa">rotateServerCa(project, instance, body=None, x__xgafv=None)</a></code></p> 133<p class="firstline">Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.</p> 134<p class="toc_element"> 135 <code><a href="#startReplica">startReplica(project, instance, x__xgafv=None)</a></code></p> 136<p class="firstline">Starts the replication in the read replica instance.</p> 137<p class="toc_element"> 138 <code><a href="#stopReplica">stopReplica(project, instance, x__xgafv=None)</a></code></p> 139<p class="firstline">Stops the replication in the read replica instance.</p> 140<p class="toc_element"> 141 <code><a href="#truncateLog">truncateLog(project, instance, body=None, x__xgafv=None)</a></code></p> 142<p class="firstline">Truncate MySQL general and slow query log tables MySQL only.</p> 143<p class="toc_element"> 144 <code><a href="#update">update(project, instance, body=None, x__xgafv=None)</a></code></p> 145<p class="firstline">Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.</p> 146<h3>Method Details</h3> 147<div class="method"> 148 <code class="details" id="addServerCa">addServerCa(project, instance, x__xgafv=None)</code> 149 <pre>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. 150 151Args: 152 project: string, Project ID of the project that contains the instance. (required) 153 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 154 x__xgafv: string, V1 error format. 155 Allowed values 156 1 - v1 error format 157 2 - v2 error format 158 159Returns: 160 An object of the form: 161 162 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 163 "backupContext": { # Backup context. # The context for backup operation, if applicable. 164 "backupId": "A String", # The identifier of the backup. 165 "kind": "A String", # This is always **sql#backupContext**. 166 }, 167 "endTime": "A String", # 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**. 168 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 169 "errors": [ # The list of errors encountered while processing this operation. 170 { # Database instance operation error. 171 "code": "A String", # Identifies the specific error that occurred. 172 "kind": "A String", # This is always **sql#operationError**. 173 "message": "A String", # Additional information about the error encountered. 174 }, 175 ], 176 "kind": "A String", # This is always **sql#operationErrors**. 177 }, 178 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 179 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 180 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 181 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 182 "linesTerminatedBy": "A String", # 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. 183 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 184 "selectQuery": "A String", # The select query used to extract the data. 185 }, 186 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 187 "A String", 188 ], 189 "fileType": "A String", # The file type for the specified uri. 190 "kind": "A String", # This is always **sql#exportContext**. 191 "offload": True or False, # Option for export offload. 192 "sqlExportOptions": { # Options for exporting data as SQL statements. 193 "mysqlExportOptions": { # Options for exporting from MySQL. 194 "masterData": 42, # 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. 195 }, 196 "schemaOnly": True or False, # Export only schemas. 197 "tables": [ # 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. 198 "A String", 199 ], 200 }, 201 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 202 }, 203 "importContext": { # Database instance import context. # The context for import operation, if applicable. 204 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 205 "encryptionOptions": { 206 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 207 "pvkPassword": "A String", # Password that encrypts the private key 208 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 209 }, 210 }, 211 "csvImportOptions": { # Options for importing data as CSV. 212 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 213 "A String", 214 ], 215 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 216 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 217 "linesTerminatedBy": "A String", # 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. 218 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 219 "table": "A String", # The table to which CSV data is imported. 220 }, 221 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 222 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 223 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 224 "kind": "A String", # This is always **sql#importContext**. 225 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 226 }, 227 "insertTime": "A String", # 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**. 228 "kind": "A String", # This is always **sql#operation**. 229 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 230 "operationType": "A String", # 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** 231 "selfLink": "A String", # The URI of this resource. 232 "startTime": "A String", # 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**. 233 "status": "A String", # The status of an operation. 234 "targetId": "A String", # Name of the database instance related to this operation. 235 "targetLink": "A String", 236 "targetProject": "A String", # The project ID of the target instance related to this operation. 237 "user": "A String", # The email address of the user who initiated this operation. 238}</pre> 239</div> 240 241<div class="method"> 242 <code class="details" id="clone">clone(project, instance, body=None, x__xgafv=None)</code> 243 <pre>Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart. 244 245Args: 246 project: string, Project ID of the source as well as the clone Cloud SQL instance. (required) 247 instance: string, The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. (required) 248 body: object, The request body. 249 The object takes the form of: 250 251{ # Database instance clone request. 252 "cloneContext": { # Database instance clone context. # Contains details about the clone operation. 253 "binLogCoordinates": { # Binary log coordinates. # 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. 254 "binLogFileName": "A String", # Name of the binary log file for a Cloud SQL instance. 255 "binLogPosition": "A String", # Position (offset) within the binary log file. 256 "kind": "A String", # This is always **sql#binLogCoordinates**. 257 }, 258 "destinationInstanceName": "A String", # Name of the Cloud SQL instance to be created as a clone. 259 "kind": "A String", # This is always **sql#cloneContext**. 260 "pitrTimestampMs": "A String", # Reserved for future use. 261 "pointInTime": "A String", # Timestamp, if specified, identifies the time to which the source instance is cloned. 262 }, 263} 264 265 x__xgafv: string, V1 error format. 266 Allowed values 267 1 - v1 error format 268 2 - v2 error format 269 270Returns: 271 An object of the form: 272 273 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 274 "backupContext": { # Backup context. # The context for backup operation, if applicable. 275 "backupId": "A String", # The identifier of the backup. 276 "kind": "A String", # This is always **sql#backupContext**. 277 }, 278 "endTime": "A String", # 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**. 279 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 280 "errors": [ # The list of errors encountered while processing this operation. 281 { # Database instance operation error. 282 "code": "A String", # Identifies the specific error that occurred. 283 "kind": "A String", # This is always **sql#operationError**. 284 "message": "A String", # Additional information about the error encountered. 285 }, 286 ], 287 "kind": "A String", # This is always **sql#operationErrors**. 288 }, 289 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 290 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 291 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 292 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 293 "linesTerminatedBy": "A String", # 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. 294 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 295 "selectQuery": "A String", # The select query used to extract the data. 296 }, 297 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 298 "A String", 299 ], 300 "fileType": "A String", # The file type for the specified uri. 301 "kind": "A String", # This is always **sql#exportContext**. 302 "offload": True or False, # Option for export offload. 303 "sqlExportOptions": { # Options for exporting data as SQL statements. 304 "mysqlExportOptions": { # Options for exporting from MySQL. 305 "masterData": 42, # 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. 306 }, 307 "schemaOnly": True or False, # Export only schemas. 308 "tables": [ # 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. 309 "A String", 310 ], 311 }, 312 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 313 }, 314 "importContext": { # Database instance import context. # The context for import operation, if applicable. 315 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 316 "encryptionOptions": { 317 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 318 "pvkPassword": "A String", # Password that encrypts the private key 319 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 320 }, 321 }, 322 "csvImportOptions": { # Options for importing data as CSV. 323 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 324 "A String", 325 ], 326 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 327 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 328 "linesTerminatedBy": "A String", # 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. 329 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 330 "table": "A String", # The table to which CSV data is imported. 331 }, 332 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 333 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 334 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 335 "kind": "A String", # This is always **sql#importContext**. 336 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 337 }, 338 "insertTime": "A String", # 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**. 339 "kind": "A String", # This is always **sql#operation**. 340 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 341 "operationType": "A String", # 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** 342 "selfLink": "A String", # The URI of this resource. 343 "startTime": "A String", # 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**. 344 "status": "A String", # The status of an operation. 345 "targetId": "A String", # Name of the database instance related to this operation. 346 "targetLink": "A String", 347 "targetProject": "A String", # The project ID of the target instance related to this operation. 348 "user": "A String", # The email address of the user who initiated this operation. 349}</pre> 350</div> 351 352<div class="method"> 353 <code class="details" id="close">close()</code> 354 <pre>Close httplib2 connections.</pre> 355</div> 356 357<div class="method"> 358 <code class="details" id="delete">delete(project, instance, x__xgafv=None)</code> 359 <pre>Deletes a Cloud SQL instance. 360 361Args: 362 project: string, Project ID of the project that contains the instance to be deleted. (required) 363 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 364 x__xgafv: string, V1 error format. 365 Allowed values 366 1 - v1 error format 367 2 - v2 error format 368 369Returns: 370 An object of the form: 371 372 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 373 "backupContext": { # Backup context. # The context for backup operation, if applicable. 374 "backupId": "A String", # The identifier of the backup. 375 "kind": "A String", # This is always **sql#backupContext**. 376 }, 377 "endTime": "A String", # 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**. 378 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 379 "errors": [ # The list of errors encountered while processing this operation. 380 { # Database instance operation error. 381 "code": "A String", # Identifies the specific error that occurred. 382 "kind": "A String", # This is always **sql#operationError**. 383 "message": "A String", # Additional information about the error encountered. 384 }, 385 ], 386 "kind": "A String", # This is always **sql#operationErrors**. 387 }, 388 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 389 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 390 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 391 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 392 "linesTerminatedBy": "A String", # 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. 393 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 394 "selectQuery": "A String", # The select query used to extract the data. 395 }, 396 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 397 "A String", 398 ], 399 "fileType": "A String", # The file type for the specified uri. 400 "kind": "A String", # This is always **sql#exportContext**. 401 "offload": True or False, # Option for export offload. 402 "sqlExportOptions": { # Options for exporting data as SQL statements. 403 "mysqlExportOptions": { # Options for exporting from MySQL. 404 "masterData": 42, # 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. 405 }, 406 "schemaOnly": True or False, # Export only schemas. 407 "tables": [ # 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. 408 "A String", 409 ], 410 }, 411 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 412 }, 413 "importContext": { # Database instance import context. # The context for import operation, if applicable. 414 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 415 "encryptionOptions": { 416 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 417 "pvkPassword": "A String", # Password that encrypts the private key 418 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 419 }, 420 }, 421 "csvImportOptions": { # Options for importing data as CSV. 422 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 423 "A String", 424 ], 425 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 426 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 427 "linesTerminatedBy": "A String", # 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. 428 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 429 "table": "A String", # The table to which CSV data is imported. 430 }, 431 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 432 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 433 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 434 "kind": "A String", # This is always **sql#importContext**. 435 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 436 }, 437 "insertTime": "A String", # 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**. 438 "kind": "A String", # This is always **sql#operation**. 439 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 440 "operationType": "A String", # 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** 441 "selfLink": "A String", # The URI of this resource. 442 "startTime": "A String", # 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**. 443 "status": "A String", # The status of an operation. 444 "targetId": "A String", # Name of the database instance related to this operation. 445 "targetLink": "A String", 446 "targetProject": "A String", # The project ID of the target instance related to this operation. 447 "user": "A String", # The email address of the user who initiated this operation. 448}</pre> 449</div> 450 451<div class="method"> 452 <code class="details" id="demoteMaster">demoteMaster(project, instance, body=None, x__xgafv=None)</code> 453 <pre>Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server. 454 455Args: 456 project: string, ID of the project that contains the instance. (required) 457 instance: string, Cloud SQL instance name. (required) 458 body: object, The request body. 459 The object takes the form of: 460 461{ # Database demote primary instance request. 462 "demoteMasterContext": { # Database instance demote primary instance context. # Contains details about the demoteMaster operation. 463 "kind": "A String", # This is always **sql#demoteMasterContext**. 464 "masterInstanceName": "A String", # The name of the instance which will act as on-premises primary instance in the replication setup. 465 "replicaConfiguration": { # Read-replica configuration for connecting to the on-premises primary instance. # Configuration specific to read-replicas replicating from the on-premises primary instance. 466 "kind": "A String", # This is always **sql#demoteMasterConfiguration**. 467 "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # 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. 468 "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. 469 "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. 470 "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8. 471 "kind": "A String", # This is always **sql#demoteMasterMysqlReplicaConfiguration**. 472 "password": "A String", # The password for the replication connection. 473 "username": "A String", # The username for the replication connection. 474 }, 475 }, 476 "skipReplicationSetup": True or False, # Flag to skip replication setup on the instance. 477 "verifyGtidConsistency": True or False, # Verify GTID consistency for demote operation. Default value: **True**. Setting this flag to false enables you to bypass GTID consistency check between on-premises primary instance and Cloud SQL instance during the demotion operation but also exposes you to the risk of future replication failures. Change the value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues. 478 }, 479} 480 481 x__xgafv: string, V1 error format. 482 Allowed values 483 1 - v1 error format 484 2 - v2 error format 485 486Returns: 487 An object of the form: 488 489 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 490 "backupContext": { # Backup context. # The context for backup operation, if applicable. 491 "backupId": "A String", # The identifier of the backup. 492 "kind": "A String", # This is always **sql#backupContext**. 493 }, 494 "endTime": "A String", # 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**. 495 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 496 "errors": [ # The list of errors encountered while processing this operation. 497 { # Database instance operation error. 498 "code": "A String", # Identifies the specific error that occurred. 499 "kind": "A String", # This is always **sql#operationError**. 500 "message": "A String", # Additional information about the error encountered. 501 }, 502 ], 503 "kind": "A String", # This is always **sql#operationErrors**. 504 }, 505 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 506 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 507 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 508 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 509 "linesTerminatedBy": "A String", # 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. 510 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 511 "selectQuery": "A String", # The select query used to extract the data. 512 }, 513 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 514 "A String", 515 ], 516 "fileType": "A String", # The file type for the specified uri. 517 "kind": "A String", # This is always **sql#exportContext**. 518 "offload": True or False, # Option for export offload. 519 "sqlExportOptions": { # Options for exporting data as SQL statements. 520 "mysqlExportOptions": { # Options for exporting from MySQL. 521 "masterData": 42, # 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. 522 }, 523 "schemaOnly": True or False, # Export only schemas. 524 "tables": [ # 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. 525 "A String", 526 ], 527 }, 528 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 529 }, 530 "importContext": { # Database instance import context. # The context for import operation, if applicable. 531 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 532 "encryptionOptions": { 533 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 534 "pvkPassword": "A String", # Password that encrypts the private key 535 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 536 }, 537 }, 538 "csvImportOptions": { # Options for importing data as CSV. 539 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 540 "A String", 541 ], 542 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 543 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 544 "linesTerminatedBy": "A String", # 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. 545 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 546 "table": "A String", # The table to which CSV data is imported. 547 }, 548 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 549 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 550 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 551 "kind": "A String", # This is always **sql#importContext**. 552 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 553 }, 554 "insertTime": "A String", # 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**. 555 "kind": "A String", # This is always **sql#operation**. 556 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 557 "operationType": "A String", # 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** 558 "selfLink": "A String", # The URI of this resource. 559 "startTime": "A String", # 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**. 560 "status": "A String", # The status of an operation. 561 "targetId": "A String", # Name of the database instance related to this operation. 562 "targetLink": "A String", 563 "targetProject": "A String", # The project ID of the target instance related to this operation. 564 "user": "A String", # The email address of the user who initiated this operation. 565}</pre> 566</div> 567 568<div class="method"> 569 <code class="details" id="export">export(project, instance, body=None, x__xgafv=None)</code> 570 <pre>Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file. 571 572Args: 573 project: string, Project ID of the project that contains the instance to be exported. (required) 574 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 575 body: object, The request body. 576 The object takes the form of: 577 578{ # Database instance export request. 579 "exportContext": { # Database instance export context. # Contains details about the export operation. 580 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 581 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 582 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 583 "linesTerminatedBy": "A String", # 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. 584 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 585 "selectQuery": "A String", # The select query used to extract the data. 586 }, 587 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 588 "A String", 589 ], 590 "fileType": "A String", # The file type for the specified uri. 591 "kind": "A String", # This is always **sql#exportContext**. 592 "offload": True or False, # Option for export offload. 593 "sqlExportOptions": { # Options for exporting data as SQL statements. 594 "mysqlExportOptions": { # Options for exporting from MySQL. 595 "masterData": 42, # 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. 596 }, 597 "schemaOnly": True or False, # Export only schemas. 598 "tables": [ # 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. 599 "A String", 600 ], 601 }, 602 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 603 }, 604} 605 606 x__xgafv: string, V1 error format. 607 Allowed values 608 1 - v1 error format 609 2 - v2 error format 610 611Returns: 612 An object of the form: 613 614 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 615 "backupContext": { # Backup context. # The context for backup operation, if applicable. 616 "backupId": "A String", # The identifier of the backup. 617 "kind": "A String", # This is always **sql#backupContext**. 618 }, 619 "endTime": "A String", # 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**. 620 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 621 "errors": [ # The list of errors encountered while processing this operation. 622 { # Database instance operation error. 623 "code": "A String", # Identifies the specific error that occurred. 624 "kind": "A String", # This is always **sql#operationError**. 625 "message": "A String", # Additional information about the error encountered. 626 }, 627 ], 628 "kind": "A String", # This is always **sql#operationErrors**. 629 }, 630 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 631 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 632 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 633 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 634 "linesTerminatedBy": "A String", # 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. 635 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 636 "selectQuery": "A String", # The select query used to extract the data. 637 }, 638 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 639 "A String", 640 ], 641 "fileType": "A String", # The file type for the specified uri. 642 "kind": "A String", # This is always **sql#exportContext**. 643 "offload": True or False, # Option for export offload. 644 "sqlExportOptions": { # Options for exporting data as SQL statements. 645 "mysqlExportOptions": { # Options for exporting from MySQL. 646 "masterData": 42, # 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. 647 }, 648 "schemaOnly": True or False, # Export only schemas. 649 "tables": [ # 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. 650 "A String", 651 ], 652 }, 653 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 654 }, 655 "importContext": { # Database instance import context. # The context for import operation, if applicable. 656 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 657 "encryptionOptions": { 658 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 659 "pvkPassword": "A String", # Password that encrypts the private key 660 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 661 }, 662 }, 663 "csvImportOptions": { # Options for importing data as CSV. 664 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 665 "A String", 666 ], 667 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 668 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 669 "linesTerminatedBy": "A String", # 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. 670 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 671 "table": "A String", # The table to which CSV data is imported. 672 }, 673 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 674 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 675 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 676 "kind": "A String", # This is always **sql#importContext**. 677 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 678 }, 679 "insertTime": "A String", # 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**. 680 "kind": "A String", # This is always **sql#operation**. 681 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 682 "operationType": "A String", # 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** 683 "selfLink": "A String", # The URI of this resource. 684 "startTime": "A String", # 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**. 685 "status": "A String", # The status of an operation. 686 "targetId": "A String", # Name of the database instance related to this operation. 687 "targetLink": "A String", 688 "targetProject": "A String", # The project ID of the target instance related to this operation. 689 "user": "A String", # The email address of the user who initiated this operation. 690}</pre> 691</div> 692 693<div class="method"> 694 <code class="details" id="failover">failover(project, instance, body=None, x__xgafv=None)</code> 695 <pre>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. 696 697Args: 698 project: string, ID of the project that contains the read replica. (required) 699 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 700 body: object, The request body. 701 The object takes the form of: 702 703{ # Instance failover request. 704 "failoverContext": { # Database instance failover context. # Failover Context. 705 "kind": "A String", # This is always **sql#failoverContext**. 706 "settingsVersion": "A String", # The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version. 707 }, 708} 709 710 x__xgafv: string, V1 error format. 711 Allowed values 712 1 - v1 error format 713 2 - v2 error format 714 715Returns: 716 An object of the form: 717 718 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 719 "backupContext": { # Backup context. # The context for backup operation, if applicable. 720 "backupId": "A String", # The identifier of the backup. 721 "kind": "A String", # This is always **sql#backupContext**. 722 }, 723 "endTime": "A String", # 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**. 724 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 725 "errors": [ # The list of errors encountered while processing this operation. 726 { # Database instance operation error. 727 "code": "A String", # Identifies the specific error that occurred. 728 "kind": "A String", # This is always **sql#operationError**. 729 "message": "A String", # Additional information about the error encountered. 730 }, 731 ], 732 "kind": "A String", # This is always **sql#operationErrors**. 733 }, 734 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 735 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 736 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 737 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 738 "linesTerminatedBy": "A String", # 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. 739 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 740 "selectQuery": "A String", # The select query used to extract the data. 741 }, 742 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 743 "A String", 744 ], 745 "fileType": "A String", # The file type for the specified uri. 746 "kind": "A String", # This is always **sql#exportContext**. 747 "offload": True or False, # Option for export offload. 748 "sqlExportOptions": { # Options for exporting data as SQL statements. 749 "mysqlExportOptions": { # Options for exporting from MySQL. 750 "masterData": 42, # 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. 751 }, 752 "schemaOnly": True or False, # Export only schemas. 753 "tables": [ # 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. 754 "A String", 755 ], 756 }, 757 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 758 }, 759 "importContext": { # Database instance import context. # The context for import operation, if applicable. 760 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 761 "encryptionOptions": { 762 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 763 "pvkPassword": "A String", # Password that encrypts the private key 764 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 765 }, 766 }, 767 "csvImportOptions": { # Options for importing data as CSV. 768 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 769 "A String", 770 ], 771 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 772 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 773 "linesTerminatedBy": "A String", # 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. 774 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 775 "table": "A String", # The table to which CSV data is imported. 776 }, 777 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 778 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 779 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 780 "kind": "A String", # This is always **sql#importContext**. 781 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 782 }, 783 "insertTime": "A String", # 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**. 784 "kind": "A String", # This is always **sql#operation**. 785 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 786 "operationType": "A String", # 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** 787 "selfLink": "A String", # The URI of this resource. 788 "startTime": "A String", # 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**. 789 "status": "A String", # The status of an operation. 790 "targetId": "A String", # Name of the database instance related to this operation. 791 "targetLink": "A String", 792 "targetProject": "A String", # The project ID of the target instance related to this operation. 793 "user": "A String", # The email address of the user who initiated this operation. 794}</pre> 795</div> 796 797<div class="method"> 798 <code class="details" id="get">get(project, instance, x__xgafv=None)</code> 799 <pre>Retrieves a resource containing information about a Cloud SQL instance. 800 801Args: 802 project: string, Project ID of the project that contains the instance. (required) 803 instance: string, Database instance ID. This does not include the project ID. (required) 804 x__xgafv: string, V1 error format. 805 Allowed values 806 1 - v1 error format 807 2 - v2 error format 808 809Returns: 810 An object of the form: 811 812 { # A Cloud SQL instance resource. 813 "backendType": "A String", # 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. 814 "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. 815 "createTime": "A String", # 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**. 816 "currentDiskSize": "A String", # 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. 817 "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. 818 "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. 819 "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. 820 "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. 821 "kmsKeyName": "A String", # Resource name of KMS key for disk encryption 822 }, 823 "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. 824 "kind": "A String", # This is always **sql#diskEncryptionStatus**. 825 "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource 826 }, 827 "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the **settings.settingsVersion** field instead. 828 "failoverReplica": { # The name and status of the failover replica. 829 "available": True or False, # 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. 830 "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. 831 }, 832 "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. 833 "instanceType": "A String", # The instance type. 834 "ipAddresses": [ # The assigned IP addresses for the instance. 835 { # Database instance IP Mapping. 836 "ipAddress": "A String", # The IP address assigned. 837 "timeToRetire": "A String", # 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. 838 "type": "A String", # 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. 839 }, 840 ], 841 "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. 842 "kind": "A String", # This is always **sql#instance**. 843 "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup. 844 "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. 845 "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. 846 "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances. 847 "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. 848 "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. 849 "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. 850 "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. 851 "hostPort": "A String", # The host and port of the on-premises instance in host:port format 852 "kind": "A String", # This is always **sql#onPremisesConfiguration**. 853 "password": "A String", # The password for connecting to on-premises instance. 854 "sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL. 855 "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. 856 "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. 857 "region": "A String", # The region of the Cloud SQL instance being referenced. 858 }, 859 "username": "A String", # The username for connecting to on-premises instance. 860 }, 861 "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # 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 862 "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers: 863 "sqlOutOfDiskState": "A String", # 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 864 }, 865 "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. 866 "region": "A String", # The geographical region. Can be: * **us-central** (**FIRST_GEN** instances only) * **us-central1** (**SECOND_GEN** instances only) * **asia-east1** or **europe-west1**. Defaults to **us-central** or **us-central1** depending on the instance type. The region cannot be changed after instance creation. 867 "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. 868 "failoverTarget": True or False, # 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. 869 "kind": "A String", # This is always **sql#replicaConfiguration**. 870 "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # 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. 871 "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. 872 "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. 873 "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. 874 "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds. 875 "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump. 876 "kind": "A String", # This is always **sql#mysqlReplicaConfiguration**. 877 "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats. 878 "password": "A String", # The password for the replication connection. 879 "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption. 880 "username": "A String", # The username for the replication connection. 881 "verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake. 882 }, 883 }, 884 "replicaNames": [ # The replicas of the instance. 885 "A String", 886 ], 887 "rootPassword": "A String", # Initial root password. Use only on creation. 888 "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use. 889 "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance. 890 "canDefer": True or False, 891 "canReschedule": True or False, # If the scheduled maintenance can be rescheduled. 892 "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline. 893 "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance. 894 }, 895 "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use. 896 "selfLink": "A String", # The URI of this resource. 897 "serverCaCert": { # SslCerts Resource # SSL configuration. 898 "cert": "A String", # PEM representation. 899 "certSerialNumber": "A String", # Serial number, as extracted from the certificate. 900 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+. 901 "createTime": "A String", # 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** 902 "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 903 "instance": "A String", # Name of the database instance. 904 "kind": "A String", # This is always **sql#sslCert**. 905 "selfLink": "A String", # The URI of this resource. 906 "sha1Fingerprint": "A String", # Sha1 Fingerprint. 907 }, 908 "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only. 909 "settings": { # Database instance settings. # The user settings. 910 "activationPolicy": "A String", # 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. 911 "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server. 912 "domain": "A String", # The name of the domain (e.g., mydomain.com). 913 "kind": "A String", # This is always sql#activeDirectoryConfig. 914 }, 915 "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only. 916 "A String", 917 ], 918 "availabilityType": "A String", # 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). 919 "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance. 920 "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings. 921 "retainedBackups": 42, # 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. 922 "retentionUnit": "A String", # The unit that 'retained_backups' represents. 923 }, 924 "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. 925 "enabled": True or False, # Whether this configuration is enabled. 926 "kind": "A String", # This is always **sql#backupConfiguration**. 927 "location": "A String", # Location of the backup 928 "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled. 929 "replicationLogArchivingEnabled": True or False, # Reserved for future use. 930 "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - **HH:MM**. 931 "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. 932 }, 933 "collation": "A String", # The name of server Instance collation. 934 "crashSafeReplicationEnabled": True or False, # 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. 935 "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. 936 "dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**. Not used for First Generation instances. 937 "databaseFlags": [ # The database flags passed to the instance at startup. 938 { # Database flags for Cloud SQL instances. 939 "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation. 940 "value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. 941 }, 942 ], 943 "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. 944 "denyMaintenancePeriods": [ # Deny maintenance periods 945 { # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied. 946 "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 947 "startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the 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 948 "time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00 949 }, 950 ], 951 "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. 952 "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. 953 "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. 954 "queryStringLength": 42, # 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. 955 "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled. 956 "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled. 957 }, 958 "ipConfiguration": { # IP Management configuration. # 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. 959 "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](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])?.` 960 "authorizedNetworks": [ # 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**). 961 { # An entry for an Access Control list. 962 "expirationTime": "A String", # 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**. 963 "kind": "A String", # This is always **sql#aclEntry**. 964 "name": "A String", # Optional. A label to identify this entry. 965 "value": "A String", # The allowlisted value for the access control list. 966 }, 967 ], 968 "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not. 969 "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, **/projects/myProject/global/networks/default**. This setting can be updated, but it cannot be removed after it is set. 970 "requireSsl": True or False, # Whether SSL connections over IP are enforced or not. 971 }, 972 "kind": "A String", # This is always **sql#settings**. 973 "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # 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. 974 "followGaeApplication": "A String", # 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. 975 "kind": "A String", # This is always **sql#locationPreference**. 976 "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. 977 "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. 978 }, 979 "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. 980 "day": 42, # day of week (1-7), starting on Monday. 981 "hour": 42, # hour of day - 0 to 23. 982 "kind": "A String", # This is always **sql#maintenanceWindow**. 983 "updateTrack": "A String", # Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more](https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen). 984 }, 985 "passwordValidationPolicy": { # Database instance local user password validation policy # The local user password validation policy of the instance. 986 "complexity": "A String", # The complexity of the password. 987 "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. 988 "minLength": 42, # Minimum number of characters allowed. 989 "passwordChangeInterval": "A String", # Minimum interval after which the password can be changed. 990 "reuseInterval": 42, # Number of previous passwords that cannot be reused. 991 }, 992 "pricingPlan": "A String", # The pricing plan for this instance. This can be either **PER_USE** or **PACKAGE**. Only **PER_USE** is supported for Second Generation instances. 993 "replicationType": "A String", # The type of replication this instance uses. This can be either **ASYNCHRONOUS** or **SYNCHRONOUS**. (Deprecated) This property was only applicable to First Generation instances. 994 "settingsVersion": "A String", # 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. 995 "sqlServerAuditConfig": { # SQL Server specific audit configuration. # SQL Server specific audit configuration. 996 "bucket": "A String", # The name of the destination bucket (e.g., gs://mybucket). 997 "kind": "A String", # This is always sql#sqlServerAuditConfig 998 }, 999 "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. 1000 "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. 1001 "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. 1002 "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. 1003 "a_key": "A String", 1004 }, 1005 }, 1006 "state": "A String", # The current serving state of the Cloud SQL instance. 1007 "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. 1008 "A String", 1009 ], 1010}</pre> 1011</div> 1012 1013<div class="method"> 1014 <code class="details" id="import_">import_(project, instance, body=None, x__xgafv=None)</code> 1015 <pre>Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage. 1016 1017Args: 1018 project: string, Project ID of the project that contains the instance. (required) 1019 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 1020 body: object, The request body. 1021 The object takes the form of: 1022 1023{ # Database instance import request. 1024 "importContext": { # Database instance import context. # Contains details about the import operation. 1025 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 1026 "encryptionOptions": { 1027 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 1028 "pvkPassword": "A String", # Password that encrypts the private key 1029 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 1030 }, 1031 }, 1032 "csvImportOptions": { # Options for importing data as CSV. 1033 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 1034 "A String", 1035 ], 1036 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 1037 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 1038 "linesTerminatedBy": "A String", # 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. 1039 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 1040 "table": "A String", # The table to which CSV data is imported. 1041 }, 1042 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 1043 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 1044 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 1045 "kind": "A String", # This is always **sql#importContext**. 1046 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 1047 }, 1048} 1049 1050 x__xgafv: string, V1 error format. 1051 Allowed values 1052 1 - v1 error format 1053 2 - v2 error format 1054 1055Returns: 1056 An object of the form: 1057 1058 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 1059 "backupContext": { # Backup context. # The context for backup operation, if applicable. 1060 "backupId": "A String", # The identifier of the backup. 1061 "kind": "A String", # This is always **sql#backupContext**. 1062 }, 1063 "endTime": "A String", # 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**. 1064 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 1065 "errors": [ # The list of errors encountered while processing this operation. 1066 { # Database instance operation error. 1067 "code": "A String", # Identifies the specific error that occurred. 1068 "kind": "A String", # This is always **sql#operationError**. 1069 "message": "A String", # Additional information about the error encountered. 1070 }, 1071 ], 1072 "kind": "A String", # This is always **sql#operationErrors**. 1073 }, 1074 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 1075 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 1076 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 1077 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 1078 "linesTerminatedBy": "A String", # 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. 1079 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 1080 "selectQuery": "A String", # The select query used to extract the data. 1081 }, 1082 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 1083 "A String", 1084 ], 1085 "fileType": "A String", # The file type for the specified uri. 1086 "kind": "A String", # This is always **sql#exportContext**. 1087 "offload": True or False, # Option for export offload. 1088 "sqlExportOptions": { # Options for exporting data as SQL statements. 1089 "mysqlExportOptions": { # Options for exporting from MySQL. 1090 "masterData": 42, # 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. 1091 }, 1092 "schemaOnly": True or False, # Export only schemas. 1093 "tables": [ # 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. 1094 "A String", 1095 ], 1096 }, 1097 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 1098 }, 1099 "importContext": { # Database instance import context. # The context for import operation, if applicable. 1100 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 1101 "encryptionOptions": { 1102 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 1103 "pvkPassword": "A String", # Password that encrypts the private key 1104 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 1105 }, 1106 }, 1107 "csvImportOptions": { # Options for importing data as CSV. 1108 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 1109 "A String", 1110 ], 1111 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 1112 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 1113 "linesTerminatedBy": "A String", # 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. 1114 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 1115 "table": "A String", # The table to which CSV data is imported. 1116 }, 1117 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 1118 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 1119 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 1120 "kind": "A String", # This is always **sql#importContext**. 1121 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 1122 }, 1123 "insertTime": "A String", # 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**. 1124 "kind": "A String", # This is always **sql#operation**. 1125 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 1126 "operationType": "A String", # 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** 1127 "selfLink": "A String", # The URI of this resource. 1128 "startTime": "A String", # 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**. 1129 "status": "A String", # The status of an operation. 1130 "targetId": "A String", # Name of the database instance related to this operation. 1131 "targetLink": "A String", 1132 "targetProject": "A String", # The project ID of the target instance related to this operation. 1133 "user": "A String", # The email address of the user who initiated this operation. 1134}</pre> 1135</div> 1136 1137<div class="method"> 1138 <code class="details" id="insert">insert(project, body=None, x__xgafv=None)</code> 1139 <pre>Creates a new Cloud SQL instance. 1140 1141Args: 1142 project: string, Project ID of the project to which the newly created Cloud SQL instances should belong. (required) 1143 body: object, The request body. 1144 The object takes the form of: 1145 1146{ # A Cloud SQL instance resource. 1147 "backendType": "A String", # 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. 1148 "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. 1149 "createTime": "A String", # 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**. 1150 "currentDiskSize": "A String", # 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. 1151 "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. 1152 "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. 1153 "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. 1154 "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. 1155 "kmsKeyName": "A String", # Resource name of KMS key for disk encryption 1156 }, 1157 "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. 1158 "kind": "A String", # This is always **sql#diskEncryptionStatus**. 1159 "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource 1160 }, 1161 "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the **settings.settingsVersion** field instead. 1162 "failoverReplica": { # The name and status of the failover replica. 1163 "available": True or False, # 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. 1164 "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. 1165 }, 1166 "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. 1167 "instanceType": "A String", # The instance type. 1168 "ipAddresses": [ # The assigned IP addresses for the instance. 1169 { # Database instance IP Mapping. 1170 "ipAddress": "A String", # The IP address assigned. 1171 "timeToRetire": "A String", # 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. 1172 "type": "A String", # 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. 1173 }, 1174 ], 1175 "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. 1176 "kind": "A String", # This is always **sql#instance**. 1177 "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup. 1178 "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. 1179 "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. 1180 "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances. 1181 "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. 1182 "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. 1183 "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. 1184 "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. 1185 "hostPort": "A String", # The host and port of the on-premises instance in host:port format 1186 "kind": "A String", # This is always **sql#onPremisesConfiguration**. 1187 "password": "A String", # The password for connecting to on-premises instance. 1188 "sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL. 1189 "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. 1190 "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. 1191 "region": "A String", # The region of the Cloud SQL instance being referenced. 1192 }, 1193 "username": "A String", # The username for connecting to on-premises instance. 1194 }, 1195 "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # 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 1196 "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers: 1197 "sqlOutOfDiskState": "A String", # 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 1198 }, 1199 "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. 1200 "region": "A String", # The geographical region. Can be: * **us-central** (**FIRST_GEN** instances only) * **us-central1** (**SECOND_GEN** instances only) * **asia-east1** or **europe-west1**. Defaults to **us-central** or **us-central1** depending on the instance type. The region cannot be changed after instance creation. 1201 "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. 1202 "failoverTarget": True or False, # 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. 1203 "kind": "A String", # This is always **sql#replicaConfiguration**. 1204 "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # 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. 1205 "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. 1206 "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. 1207 "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. 1208 "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds. 1209 "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump. 1210 "kind": "A String", # This is always **sql#mysqlReplicaConfiguration**. 1211 "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats. 1212 "password": "A String", # The password for the replication connection. 1213 "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption. 1214 "username": "A String", # The username for the replication connection. 1215 "verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake. 1216 }, 1217 }, 1218 "replicaNames": [ # The replicas of the instance. 1219 "A String", 1220 ], 1221 "rootPassword": "A String", # Initial root password. Use only on creation. 1222 "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use. 1223 "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance. 1224 "canDefer": True or False, 1225 "canReschedule": True or False, # If the scheduled maintenance can be rescheduled. 1226 "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline. 1227 "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance. 1228 }, 1229 "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use. 1230 "selfLink": "A String", # The URI of this resource. 1231 "serverCaCert": { # SslCerts Resource # SSL configuration. 1232 "cert": "A String", # PEM representation. 1233 "certSerialNumber": "A String", # Serial number, as extracted from the certificate. 1234 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+. 1235 "createTime": "A String", # 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** 1236 "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 1237 "instance": "A String", # Name of the database instance. 1238 "kind": "A String", # This is always **sql#sslCert**. 1239 "selfLink": "A String", # The URI of this resource. 1240 "sha1Fingerprint": "A String", # Sha1 Fingerprint. 1241 }, 1242 "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only. 1243 "settings": { # Database instance settings. # The user settings. 1244 "activationPolicy": "A String", # 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. 1245 "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server. 1246 "domain": "A String", # The name of the domain (e.g., mydomain.com). 1247 "kind": "A String", # This is always sql#activeDirectoryConfig. 1248 }, 1249 "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only. 1250 "A String", 1251 ], 1252 "availabilityType": "A String", # 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). 1253 "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance. 1254 "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings. 1255 "retainedBackups": 42, # 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. 1256 "retentionUnit": "A String", # The unit that 'retained_backups' represents. 1257 }, 1258 "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. 1259 "enabled": True or False, # Whether this configuration is enabled. 1260 "kind": "A String", # This is always **sql#backupConfiguration**. 1261 "location": "A String", # Location of the backup 1262 "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled. 1263 "replicationLogArchivingEnabled": True or False, # Reserved for future use. 1264 "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - **HH:MM**. 1265 "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. 1266 }, 1267 "collation": "A String", # The name of server Instance collation. 1268 "crashSafeReplicationEnabled": True or False, # 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. 1269 "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. 1270 "dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**. Not used for First Generation instances. 1271 "databaseFlags": [ # The database flags passed to the instance at startup. 1272 { # Database flags for Cloud SQL instances. 1273 "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation. 1274 "value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. 1275 }, 1276 ], 1277 "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. 1278 "denyMaintenancePeriods": [ # Deny maintenance periods 1279 { # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied. 1280 "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 1281 "startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the 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 1282 "time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00 1283 }, 1284 ], 1285 "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. 1286 "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. 1287 "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. 1288 "queryStringLength": 42, # 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. 1289 "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled. 1290 "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled. 1291 }, 1292 "ipConfiguration": { # IP Management configuration. # 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. 1293 "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](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])?.` 1294 "authorizedNetworks": [ # 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**). 1295 { # An entry for an Access Control list. 1296 "expirationTime": "A String", # 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**. 1297 "kind": "A String", # This is always **sql#aclEntry**. 1298 "name": "A String", # Optional. A label to identify this entry. 1299 "value": "A String", # The allowlisted value for the access control list. 1300 }, 1301 ], 1302 "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not. 1303 "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, **/projects/myProject/global/networks/default**. This setting can be updated, but it cannot be removed after it is set. 1304 "requireSsl": True or False, # Whether SSL connections over IP are enforced or not. 1305 }, 1306 "kind": "A String", # This is always **sql#settings**. 1307 "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # 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. 1308 "followGaeApplication": "A String", # 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. 1309 "kind": "A String", # This is always **sql#locationPreference**. 1310 "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. 1311 "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. 1312 }, 1313 "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. 1314 "day": 42, # day of week (1-7), starting on Monday. 1315 "hour": 42, # hour of day - 0 to 23. 1316 "kind": "A String", # This is always **sql#maintenanceWindow**. 1317 "updateTrack": "A String", # Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more](https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen). 1318 }, 1319 "passwordValidationPolicy": { # Database instance local user password validation policy # The local user password validation policy of the instance. 1320 "complexity": "A String", # The complexity of the password. 1321 "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. 1322 "minLength": 42, # Minimum number of characters allowed. 1323 "passwordChangeInterval": "A String", # Minimum interval after which the password can be changed. 1324 "reuseInterval": 42, # Number of previous passwords that cannot be reused. 1325 }, 1326 "pricingPlan": "A String", # The pricing plan for this instance. This can be either **PER_USE** or **PACKAGE**. Only **PER_USE** is supported for Second Generation instances. 1327 "replicationType": "A String", # The type of replication this instance uses. This can be either **ASYNCHRONOUS** or **SYNCHRONOUS**. (Deprecated) This property was only applicable to First Generation instances. 1328 "settingsVersion": "A String", # 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. 1329 "sqlServerAuditConfig": { # SQL Server specific audit configuration. # SQL Server specific audit configuration. 1330 "bucket": "A String", # The name of the destination bucket (e.g., gs://mybucket). 1331 "kind": "A String", # This is always sql#sqlServerAuditConfig 1332 }, 1333 "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. 1334 "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. 1335 "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. 1336 "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. 1337 "a_key": "A String", 1338 }, 1339 }, 1340 "state": "A String", # The current serving state of the Cloud SQL instance. 1341 "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. 1342 "A String", 1343 ], 1344} 1345 1346 x__xgafv: string, V1 error format. 1347 Allowed values 1348 1 - v1 error format 1349 2 - v2 error format 1350 1351Returns: 1352 An object of the form: 1353 1354 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 1355 "backupContext": { # Backup context. # The context for backup operation, if applicable. 1356 "backupId": "A String", # The identifier of the backup. 1357 "kind": "A String", # This is always **sql#backupContext**. 1358 }, 1359 "endTime": "A String", # 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**. 1360 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 1361 "errors": [ # The list of errors encountered while processing this operation. 1362 { # Database instance operation error. 1363 "code": "A String", # Identifies the specific error that occurred. 1364 "kind": "A String", # This is always **sql#operationError**. 1365 "message": "A String", # Additional information about the error encountered. 1366 }, 1367 ], 1368 "kind": "A String", # This is always **sql#operationErrors**. 1369 }, 1370 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 1371 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 1372 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 1373 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 1374 "linesTerminatedBy": "A String", # 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. 1375 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 1376 "selectQuery": "A String", # The select query used to extract the data. 1377 }, 1378 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 1379 "A String", 1380 ], 1381 "fileType": "A String", # The file type for the specified uri. 1382 "kind": "A String", # This is always **sql#exportContext**. 1383 "offload": True or False, # Option for export offload. 1384 "sqlExportOptions": { # Options for exporting data as SQL statements. 1385 "mysqlExportOptions": { # Options for exporting from MySQL. 1386 "masterData": 42, # 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. 1387 }, 1388 "schemaOnly": True or False, # Export only schemas. 1389 "tables": [ # 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. 1390 "A String", 1391 ], 1392 }, 1393 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 1394 }, 1395 "importContext": { # Database instance import context. # The context for import operation, if applicable. 1396 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 1397 "encryptionOptions": { 1398 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 1399 "pvkPassword": "A String", # Password that encrypts the private key 1400 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 1401 }, 1402 }, 1403 "csvImportOptions": { # Options for importing data as CSV. 1404 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 1405 "A String", 1406 ], 1407 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 1408 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 1409 "linesTerminatedBy": "A String", # 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. 1410 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 1411 "table": "A String", # The table to which CSV data is imported. 1412 }, 1413 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 1414 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 1415 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 1416 "kind": "A String", # This is always **sql#importContext**. 1417 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 1418 }, 1419 "insertTime": "A String", # 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**. 1420 "kind": "A String", # This is always **sql#operation**. 1421 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 1422 "operationType": "A String", # 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** 1423 "selfLink": "A String", # The URI of this resource. 1424 "startTime": "A String", # 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**. 1425 "status": "A String", # The status of an operation. 1426 "targetId": "A String", # Name of the database instance related to this operation. 1427 "targetLink": "A String", 1428 "targetProject": "A String", # The project ID of the target instance related to this operation. 1429 "user": "A String", # The email address of the user who initiated this operation. 1430}</pre> 1431</div> 1432 1433<div class="method"> 1434 <code class="details" id="list">list(project, filter=None, maxResults=None, pageToken=None, x__xgafv=None)</code> 1435 <pre>Lists instances under a given project. 1436 1437Args: 1438 project: string, Project ID of the project for which to list Cloud SQL instances. (required) 1439 filter: string, 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. 1440 maxResults: integer, The maximum number of results to return per response. 1441 pageToken: string, A previously-returned page token representing part of the larger set of results to view. 1442 x__xgafv: string, V1 error format. 1443 Allowed values 1444 1 - v1 error format 1445 2 - v2 error format 1446 1447Returns: 1448 An object of the form: 1449 1450 { # Database instances list response. 1451 "items": [ # List of database instance resources. 1452 { # A Cloud SQL instance resource. 1453 "backendType": "A String", # 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. 1454 "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. 1455 "createTime": "A String", # 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**. 1456 "currentDiskSize": "A String", # 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. 1457 "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. 1458 "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. 1459 "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. 1460 "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. 1461 "kmsKeyName": "A String", # Resource name of KMS key for disk encryption 1462 }, 1463 "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. 1464 "kind": "A String", # This is always **sql#diskEncryptionStatus**. 1465 "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource 1466 }, 1467 "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the **settings.settingsVersion** field instead. 1468 "failoverReplica": { # The name and status of the failover replica. 1469 "available": True or False, # 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. 1470 "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. 1471 }, 1472 "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. 1473 "instanceType": "A String", # The instance type. 1474 "ipAddresses": [ # The assigned IP addresses for the instance. 1475 { # Database instance IP Mapping. 1476 "ipAddress": "A String", # The IP address assigned. 1477 "timeToRetire": "A String", # 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. 1478 "type": "A String", # 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. 1479 }, 1480 ], 1481 "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. 1482 "kind": "A String", # This is always **sql#instance**. 1483 "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup. 1484 "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. 1485 "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. 1486 "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances. 1487 "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. 1488 "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. 1489 "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. 1490 "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. 1491 "hostPort": "A String", # The host and port of the on-premises instance in host:port format 1492 "kind": "A String", # This is always **sql#onPremisesConfiguration**. 1493 "password": "A String", # The password for connecting to on-premises instance. 1494 "sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL. 1495 "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. 1496 "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. 1497 "region": "A String", # The region of the Cloud SQL instance being referenced. 1498 }, 1499 "username": "A String", # The username for connecting to on-premises instance. 1500 }, 1501 "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # 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 1502 "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers: 1503 "sqlOutOfDiskState": "A String", # 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 1504 }, 1505 "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. 1506 "region": "A String", # The geographical region. Can be: * **us-central** (**FIRST_GEN** instances only) * **us-central1** (**SECOND_GEN** instances only) * **asia-east1** or **europe-west1**. Defaults to **us-central** or **us-central1** depending on the instance type. The region cannot be changed after instance creation. 1507 "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. 1508 "failoverTarget": True or False, # 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. 1509 "kind": "A String", # This is always **sql#replicaConfiguration**. 1510 "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # 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. 1511 "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. 1512 "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. 1513 "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. 1514 "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds. 1515 "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump. 1516 "kind": "A String", # This is always **sql#mysqlReplicaConfiguration**. 1517 "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats. 1518 "password": "A String", # The password for the replication connection. 1519 "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption. 1520 "username": "A String", # The username for the replication connection. 1521 "verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake. 1522 }, 1523 }, 1524 "replicaNames": [ # The replicas of the instance. 1525 "A String", 1526 ], 1527 "rootPassword": "A String", # Initial root password. Use only on creation. 1528 "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use. 1529 "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance. 1530 "canDefer": True or False, 1531 "canReschedule": True or False, # If the scheduled maintenance can be rescheduled. 1532 "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline. 1533 "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance. 1534 }, 1535 "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use. 1536 "selfLink": "A String", # The URI of this resource. 1537 "serverCaCert": { # SslCerts Resource # SSL configuration. 1538 "cert": "A String", # PEM representation. 1539 "certSerialNumber": "A String", # Serial number, as extracted from the certificate. 1540 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+. 1541 "createTime": "A String", # 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** 1542 "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 1543 "instance": "A String", # Name of the database instance. 1544 "kind": "A String", # This is always **sql#sslCert**. 1545 "selfLink": "A String", # The URI of this resource. 1546 "sha1Fingerprint": "A String", # Sha1 Fingerprint. 1547 }, 1548 "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only. 1549 "settings": { # Database instance settings. # The user settings. 1550 "activationPolicy": "A String", # 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. 1551 "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server. 1552 "domain": "A String", # The name of the domain (e.g., mydomain.com). 1553 "kind": "A String", # This is always sql#activeDirectoryConfig. 1554 }, 1555 "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only. 1556 "A String", 1557 ], 1558 "availabilityType": "A String", # 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). 1559 "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance. 1560 "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings. 1561 "retainedBackups": 42, # 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. 1562 "retentionUnit": "A String", # The unit that 'retained_backups' represents. 1563 }, 1564 "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. 1565 "enabled": True or False, # Whether this configuration is enabled. 1566 "kind": "A String", # This is always **sql#backupConfiguration**. 1567 "location": "A String", # Location of the backup 1568 "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled. 1569 "replicationLogArchivingEnabled": True or False, # Reserved for future use. 1570 "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - **HH:MM**. 1571 "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. 1572 }, 1573 "collation": "A String", # The name of server Instance collation. 1574 "crashSafeReplicationEnabled": True or False, # 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. 1575 "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. 1576 "dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**. Not used for First Generation instances. 1577 "databaseFlags": [ # The database flags passed to the instance at startup. 1578 { # Database flags for Cloud SQL instances. 1579 "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation. 1580 "value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. 1581 }, 1582 ], 1583 "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. 1584 "denyMaintenancePeriods": [ # Deny maintenance periods 1585 { # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied. 1586 "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 1587 "startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the 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 1588 "time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00 1589 }, 1590 ], 1591 "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. 1592 "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. 1593 "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. 1594 "queryStringLength": 42, # 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. 1595 "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled. 1596 "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled. 1597 }, 1598 "ipConfiguration": { # IP Management configuration. # 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. 1599 "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](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])?.` 1600 "authorizedNetworks": [ # 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**). 1601 { # An entry for an Access Control list. 1602 "expirationTime": "A String", # 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**. 1603 "kind": "A String", # This is always **sql#aclEntry**. 1604 "name": "A String", # Optional. A label to identify this entry. 1605 "value": "A String", # The allowlisted value for the access control list. 1606 }, 1607 ], 1608 "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not. 1609 "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, **/projects/myProject/global/networks/default**. This setting can be updated, but it cannot be removed after it is set. 1610 "requireSsl": True or False, # Whether SSL connections over IP are enforced or not. 1611 }, 1612 "kind": "A String", # This is always **sql#settings**. 1613 "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # 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. 1614 "followGaeApplication": "A String", # 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. 1615 "kind": "A String", # This is always **sql#locationPreference**. 1616 "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. 1617 "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. 1618 }, 1619 "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. 1620 "day": 42, # day of week (1-7), starting on Monday. 1621 "hour": 42, # hour of day - 0 to 23. 1622 "kind": "A String", # This is always **sql#maintenanceWindow**. 1623 "updateTrack": "A String", # Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more](https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen). 1624 }, 1625 "passwordValidationPolicy": { # Database instance local user password validation policy # The local user password validation policy of the instance. 1626 "complexity": "A String", # The complexity of the password. 1627 "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. 1628 "minLength": 42, # Minimum number of characters allowed. 1629 "passwordChangeInterval": "A String", # Minimum interval after which the password can be changed. 1630 "reuseInterval": 42, # Number of previous passwords that cannot be reused. 1631 }, 1632 "pricingPlan": "A String", # The pricing plan for this instance. This can be either **PER_USE** or **PACKAGE**. Only **PER_USE** is supported for Second Generation instances. 1633 "replicationType": "A String", # The type of replication this instance uses. This can be either **ASYNCHRONOUS** or **SYNCHRONOUS**. (Deprecated) This property was only applicable to First Generation instances. 1634 "settingsVersion": "A String", # 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. 1635 "sqlServerAuditConfig": { # SQL Server specific audit configuration. # SQL Server specific audit configuration. 1636 "bucket": "A String", # The name of the destination bucket (e.g., gs://mybucket). 1637 "kind": "A String", # This is always sql#sqlServerAuditConfig 1638 }, 1639 "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. 1640 "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. 1641 "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. 1642 "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. 1643 "a_key": "A String", 1644 }, 1645 }, 1646 "state": "A String", # The current serving state of the Cloud SQL instance. 1647 "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. 1648 "A String", 1649 ], 1650 }, 1651 ], 1652 "kind": "A String", # This is always **sql#instancesList**. 1653 "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. 1654 "warnings": [ # List of warnings that occurred while handling the request. 1655 { # An Admin API warning message. 1656 "code": "A String", # Code to uniquely identify the warning type. 1657 "message": "A String", # The warning message. 1658 "region": "A String", # The region name for REGION_UNREACHABLE warning. 1659 }, 1660 ], 1661}</pre> 1662</div> 1663 1664<div class="method"> 1665 <code class="details" id="listServerCas">listServerCas(project, instance, x__xgafv=None)</code> 1666 <pre>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. 1667 1668Args: 1669 project: string, Project ID of the project that contains the instance. (required) 1670 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 1671 x__xgafv: string, V1 error format. 1672 Allowed values 1673 1 - v1 error format 1674 2 - v2 error format 1675 1676Returns: 1677 An object of the form: 1678 1679 { # Instances ListServerCas response. 1680 "activeVersion": "A String", 1681 "certs": [ # List of server CA certificates for the instance. 1682 { # SslCerts Resource 1683 "cert": "A String", # PEM representation. 1684 "certSerialNumber": "A String", # Serial number, as extracted from the certificate. 1685 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+. 1686 "createTime": "A String", # 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** 1687 "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 1688 "instance": "A String", # Name of the database instance. 1689 "kind": "A String", # This is always **sql#sslCert**. 1690 "selfLink": "A String", # The URI of this resource. 1691 "sha1Fingerprint": "A String", # Sha1 Fingerprint. 1692 }, 1693 ], 1694 "kind": "A String", # This is always **sql#instancesListServerCas**. 1695}</pre> 1696</div> 1697 1698<div class="method"> 1699 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1700 <pre>Retrieves the next page of results. 1701 1702Args: 1703 previous_request: The request for the previous page. (required) 1704 previous_response: The response from the request for the previous page. (required) 1705 1706Returns: 1707 A request object that you can call 'execute()' on to request the next 1708 page. Returns None if there are no more items in the collection. 1709 </pre> 1710</div> 1711 1712<div class="method"> 1713 <code class="details" id="patch">patch(project, instance, body=None, x__xgafv=None)</code> 1714 <pre>Updates settings of a Cloud SQL instance. This method supports patch semantics. 1715 1716Args: 1717 project: string, Project ID of the project that contains the instance. (required) 1718 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 1719 body: object, The request body. 1720 The object takes the form of: 1721 1722{ # A Cloud SQL instance resource. 1723 "backendType": "A String", # 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. 1724 "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. 1725 "createTime": "A String", # 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**. 1726 "currentDiskSize": "A String", # 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. 1727 "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. 1728 "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. 1729 "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. 1730 "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. 1731 "kmsKeyName": "A String", # Resource name of KMS key for disk encryption 1732 }, 1733 "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. 1734 "kind": "A String", # This is always **sql#diskEncryptionStatus**. 1735 "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource 1736 }, 1737 "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the **settings.settingsVersion** field instead. 1738 "failoverReplica": { # The name and status of the failover replica. 1739 "available": True or False, # 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. 1740 "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. 1741 }, 1742 "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. 1743 "instanceType": "A String", # The instance type. 1744 "ipAddresses": [ # The assigned IP addresses for the instance. 1745 { # Database instance IP Mapping. 1746 "ipAddress": "A String", # The IP address assigned. 1747 "timeToRetire": "A String", # 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. 1748 "type": "A String", # 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. 1749 }, 1750 ], 1751 "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. 1752 "kind": "A String", # This is always **sql#instance**. 1753 "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup. 1754 "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. 1755 "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. 1756 "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances. 1757 "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. 1758 "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. 1759 "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. 1760 "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. 1761 "hostPort": "A String", # The host and port of the on-premises instance in host:port format 1762 "kind": "A String", # This is always **sql#onPremisesConfiguration**. 1763 "password": "A String", # The password for connecting to on-premises instance. 1764 "sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL. 1765 "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. 1766 "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. 1767 "region": "A String", # The region of the Cloud SQL instance being referenced. 1768 }, 1769 "username": "A String", # The username for connecting to on-premises instance. 1770 }, 1771 "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # 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 1772 "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers: 1773 "sqlOutOfDiskState": "A String", # 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 1774 }, 1775 "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. 1776 "region": "A String", # The geographical region. Can be: * **us-central** (**FIRST_GEN** instances only) * **us-central1** (**SECOND_GEN** instances only) * **asia-east1** or **europe-west1**. Defaults to **us-central** or **us-central1** depending on the instance type. The region cannot be changed after instance creation. 1777 "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. 1778 "failoverTarget": True or False, # 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. 1779 "kind": "A String", # This is always **sql#replicaConfiguration**. 1780 "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # 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. 1781 "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. 1782 "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. 1783 "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. 1784 "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds. 1785 "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump. 1786 "kind": "A String", # This is always **sql#mysqlReplicaConfiguration**. 1787 "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats. 1788 "password": "A String", # The password for the replication connection. 1789 "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption. 1790 "username": "A String", # The username for the replication connection. 1791 "verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake. 1792 }, 1793 }, 1794 "replicaNames": [ # The replicas of the instance. 1795 "A String", 1796 ], 1797 "rootPassword": "A String", # Initial root password. Use only on creation. 1798 "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use. 1799 "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance. 1800 "canDefer": True or False, 1801 "canReschedule": True or False, # If the scheduled maintenance can be rescheduled. 1802 "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline. 1803 "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance. 1804 }, 1805 "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use. 1806 "selfLink": "A String", # The URI of this resource. 1807 "serverCaCert": { # SslCerts Resource # SSL configuration. 1808 "cert": "A String", # PEM representation. 1809 "certSerialNumber": "A String", # Serial number, as extracted from the certificate. 1810 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+. 1811 "createTime": "A String", # 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** 1812 "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 1813 "instance": "A String", # Name of the database instance. 1814 "kind": "A String", # This is always **sql#sslCert**. 1815 "selfLink": "A String", # The URI of this resource. 1816 "sha1Fingerprint": "A String", # Sha1 Fingerprint. 1817 }, 1818 "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only. 1819 "settings": { # Database instance settings. # The user settings. 1820 "activationPolicy": "A String", # 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. 1821 "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server. 1822 "domain": "A String", # The name of the domain (e.g., mydomain.com). 1823 "kind": "A String", # This is always sql#activeDirectoryConfig. 1824 }, 1825 "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only. 1826 "A String", 1827 ], 1828 "availabilityType": "A String", # 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). 1829 "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance. 1830 "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings. 1831 "retainedBackups": 42, # 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. 1832 "retentionUnit": "A String", # The unit that 'retained_backups' represents. 1833 }, 1834 "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. 1835 "enabled": True or False, # Whether this configuration is enabled. 1836 "kind": "A String", # This is always **sql#backupConfiguration**. 1837 "location": "A String", # Location of the backup 1838 "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled. 1839 "replicationLogArchivingEnabled": True or False, # Reserved for future use. 1840 "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - **HH:MM**. 1841 "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. 1842 }, 1843 "collation": "A String", # The name of server Instance collation. 1844 "crashSafeReplicationEnabled": True or False, # 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. 1845 "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. 1846 "dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**. Not used for First Generation instances. 1847 "databaseFlags": [ # The database flags passed to the instance at startup. 1848 { # Database flags for Cloud SQL instances. 1849 "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation. 1850 "value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. 1851 }, 1852 ], 1853 "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. 1854 "denyMaintenancePeriods": [ # Deny maintenance periods 1855 { # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied. 1856 "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 1857 "startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the 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 1858 "time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00 1859 }, 1860 ], 1861 "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. 1862 "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. 1863 "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. 1864 "queryStringLength": 42, # 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. 1865 "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled. 1866 "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled. 1867 }, 1868 "ipConfiguration": { # IP Management configuration. # 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. 1869 "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](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])?.` 1870 "authorizedNetworks": [ # 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**). 1871 { # An entry for an Access Control list. 1872 "expirationTime": "A String", # 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**. 1873 "kind": "A String", # This is always **sql#aclEntry**. 1874 "name": "A String", # Optional. A label to identify this entry. 1875 "value": "A String", # The allowlisted value for the access control list. 1876 }, 1877 ], 1878 "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not. 1879 "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, **/projects/myProject/global/networks/default**. This setting can be updated, but it cannot be removed after it is set. 1880 "requireSsl": True or False, # Whether SSL connections over IP are enforced or not. 1881 }, 1882 "kind": "A String", # This is always **sql#settings**. 1883 "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # 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. 1884 "followGaeApplication": "A String", # 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. 1885 "kind": "A String", # This is always **sql#locationPreference**. 1886 "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. 1887 "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. 1888 }, 1889 "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. 1890 "day": 42, # day of week (1-7), starting on Monday. 1891 "hour": 42, # hour of day - 0 to 23. 1892 "kind": "A String", # This is always **sql#maintenanceWindow**. 1893 "updateTrack": "A String", # Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more](https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen). 1894 }, 1895 "passwordValidationPolicy": { # Database instance local user password validation policy # The local user password validation policy of the instance. 1896 "complexity": "A String", # The complexity of the password. 1897 "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. 1898 "minLength": 42, # Minimum number of characters allowed. 1899 "passwordChangeInterval": "A String", # Minimum interval after which the password can be changed. 1900 "reuseInterval": 42, # Number of previous passwords that cannot be reused. 1901 }, 1902 "pricingPlan": "A String", # The pricing plan for this instance. This can be either **PER_USE** or **PACKAGE**. Only **PER_USE** is supported for Second Generation instances. 1903 "replicationType": "A String", # The type of replication this instance uses. This can be either **ASYNCHRONOUS** or **SYNCHRONOUS**. (Deprecated) This property was only applicable to First Generation instances. 1904 "settingsVersion": "A String", # 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. 1905 "sqlServerAuditConfig": { # SQL Server specific audit configuration. # SQL Server specific audit configuration. 1906 "bucket": "A String", # The name of the destination bucket (e.g., gs://mybucket). 1907 "kind": "A String", # This is always sql#sqlServerAuditConfig 1908 }, 1909 "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. 1910 "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. 1911 "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. 1912 "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. 1913 "a_key": "A String", 1914 }, 1915 }, 1916 "state": "A String", # The current serving state of the Cloud SQL instance. 1917 "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. 1918 "A String", 1919 ], 1920} 1921 1922 x__xgafv: string, V1 error format. 1923 Allowed values 1924 1 - v1 error format 1925 2 - v2 error format 1926 1927Returns: 1928 An object of the form: 1929 1930 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 1931 "backupContext": { # Backup context. # The context for backup operation, if applicable. 1932 "backupId": "A String", # The identifier of the backup. 1933 "kind": "A String", # This is always **sql#backupContext**. 1934 }, 1935 "endTime": "A String", # 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**. 1936 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 1937 "errors": [ # The list of errors encountered while processing this operation. 1938 { # Database instance operation error. 1939 "code": "A String", # Identifies the specific error that occurred. 1940 "kind": "A String", # This is always **sql#operationError**. 1941 "message": "A String", # Additional information about the error encountered. 1942 }, 1943 ], 1944 "kind": "A String", # This is always **sql#operationErrors**. 1945 }, 1946 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 1947 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 1948 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 1949 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 1950 "linesTerminatedBy": "A String", # 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. 1951 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 1952 "selectQuery": "A String", # The select query used to extract the data. 1953 }, 1954 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 1955 "A String", 1956 ], 1957 "fileType": "A String", # The file type for the specified uri. 1958 "kind": "A String", # This is always **sql#exportContext**. 1959 "offload": True or False, # Option for export offload. 1960 "sqlExportOptions": { # Options for exporting data as SQL statements. 1961 "mysqlExportOptions": { # Options for exporting from MySQL. 1962 "masterData": 42, # 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. 1963 }, 1964 "schemaOnly": True or False, # Export only schemas. 1965 "tables": [ # 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. 1966 "A String", 1967 ], 1968 }, 1969 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 1970 }, 1971 "importContext": { # Database instance import context. # The context for import operation, if applicable. 1972 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 1973 "encryptionOptions": { 1974 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 1975 "pvkPassword": "A String", # Password that encrypts the private key 1976 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 1977 }, 1978 }, 1979 "csvImportOptions": { # Options for importing data as CSV. 1980 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 1981 "A String", 1982 ], 1983 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 1984 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 1985 "linesTerminatedBy": "A String", # 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. 1986 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 1987 "table": "A String", # The table to which CSV data is imported. 1988 }, 1989 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 1990 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 1991 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 1992 "kind": "A String", # This is always **sql#importContext**. 1993 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 1994 }, 1995 "insertTime": "A String", # 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**. 1996 "kind": "A String", # This is always **sql#operation**. 1997 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 1998 "operationType": "A String", # 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** 1999 "selfLink": "A String", # The URI of this resource. 2000 "startTime": "A String", # 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**. 2001 "status": "A String", # The status of an operation. 2002 "targetId": "A String", # Name of the database instance related to this operation. 2003 "targetLink": "A String", 2004 "targetProject": "A String", # The project ID of the target instance related to this operation. 2005 "user": "A String", # The email address of the user who initiated this operation. 2006}</pre> 2007</div> 2008 2009<div class="method"> 2010 <code class="details" id="promoteReplica">promoteReplica(project, instance, x__xgafv=None)</code> 2011 <pre>Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart. 2012 2013Args: 2014 project: string, ID of the project that contains the read replica. (required) 2015 instance: string, Cloud SQL read replica instance name. (required) 2016 x__xgafv: string, V1 error format. 2017 Allowed values 2018 1 - v1 error format 2019 2 - v2 error format 2020 2021Returns: 2022 An object of the form: 2023 2024 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 2025 "backupContext": { # Backup context. # The context for backup operation, if applicable. 2026 "backupId": "A String", # The identifier of the backup. 2027 "kind": "A String", # This is always **sql#backupContext**. 2028 }, 2029 "endTime": "A String", # 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**. 2030 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 2031 "errors": [ # The list of errors encountered while processing this operation. 2032 { # Database instance operation error. 2033 "code": "A String", # Identifies the specific error that occurred. 2034 "kind": "A String", # This is always **sql#operationError**. 2035 "message": "A String", # Additional information about the error encountered. 2036 }, 2037 ], 2038 "kind": "A String", # This is always **sql#operationErrors**. 2039 }, 2040 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 2041 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 2042 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2043 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2044 "linesTerminatedBy": "A String", # 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. 2045 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2046 "selectQuery": "A String", # The select query used to extract the data. 2047 }, 2048 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 2049 "A String", 2050 ], 2051 "fileType": "A String", # The file type for the specified uri. 2052 "kind": "A String", # This is always **sql#exportContext**. 2053 "offload": True or False, # Option for export offload. 2054 "sqlExportOptions": { # Options for exporting data as SQL statements. 2055 "mysqlExportOptions": { # Options for exporting from MySQL. 2056 "masterData": 42, # 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. 2057 }, 2058 "schemaOnly": True or False, # Export only schemas. 2059 "tables": [ # 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. 2060 "A String", 2061 ], 2062 }, 2063 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 2064 }, 2065 "importContext": { # Database instance import context. # The context for import operation, if applicable. 2066 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 2067 "encryptionOptions": { 2068 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2069 "pvkPassword": "A String", # Password that encrypts the private key 2070 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2071 }, 2072 }, 2073 "csvImportOptions": { # Options for importing data as CSV. 2074 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 2075 "A String", 2076 ], 2077 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2078 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2079 "linesTerminatedBy": "A String", # 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. 2080 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2081 "table": "A String", # The table to which CSV data is imported. 2082 }, 2083 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 2084 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 2085 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 2086 "kind": "A String", # This is always **sql#importContext**. 2087 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 2088 }, 2089 "insertTime": "A String", # 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**. 2090 "kind": "A String", # This is always **sql#operation**. 2091 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 2092 "operationType": "A String", # 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** 2093 "selfLink": "A String", # The URI of this resource. 2094 "startTime": "A String", # 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**. 2095 "status": "A String", # The status of an operation. 2096 "targetId": "A String", # Name of the database instance related to this operation. 2097 "targetLink": "A String", 2098 "targetProject": "A String", # The project ID of the target instance related to this operation. 2099 "user": "A String", # The email address of the user who initiated this operation. 2100}</pre> 2101</div> 2102 2103<div class="method"> 2104 <code class="details" id="resetSslConfig">resetSslConfig(project, instance, x__xgafv=None)</code> 2105 <pre>Deletes all client certificates and generates a new server SSL certificate for the instance. 2106 2107Args: 2108 project: string, Project ID of the project that contains the instance. (required) 2109 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 2110 x__xgafv: string, V1 error format. 2111 Allowed values 2112 1 - v1 error format 2113 2 - v2 error format 2114 2115Returns: 2116 An object of the form: 2117 2118 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 2119 "backupContext": { # Backup context. # The context for backup operation, if applicable. 2120 "backupId": "A String", # The identifier of the backup. 2121 "kind": "A String", # This is always **sql#backupContext**. 2122 }, 2123 "endTime": "A String", # 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**. 2124 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 2125 "errors": [ # The list of errors encountered while processing this operation. 2126 { # Database instance operation error. 2127 "code": "A String", # Identifies the specific error that occurred. 2128 "kind": "A String", # This is always **sql#operationError**. 2129 "message": "A String", # Additional information about the error encountered. 2130 }, 2131 ], 2132 "kind": "A String", # This is always **sql#operationErrors**. 2133 }, 2134 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 2135 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 2136 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2137 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2138 "linesTerminatedBy": "A String", # 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. 2139 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2140 "selectQuery": "A String", # The select query used to extract the data. 2141 }, 2142 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 2143 "A String", 2144 ], 2145 "fileType": "A String", # The file type for the specified uri. 2146 "kind": "A String", # This is always **sql#exportContext**. 2147 "offload": True or False, # Option for export offload. 2148 "sqlExportOptions": { # Options for exporting data as SQL statements. 2149 "mysqlExportOptions": { # Options for exporting from MySQL. 2150 "masterData": 42, # 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. 2151 }, 2152 "schemaOnly": True or False, # Export only schemas. 2153 "tables": [ # 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. 2154 "A String", 2155 ], 2156 }, 2157 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 2158 }, 2159 "importContext": { # Database instance import context. # The context for import operation, if applicable. 2160 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 2161 "encryptionOptions": { 2162 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2163 "pvkPassword": "A String", # Password that encrypts the private key 2164 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2165 }, 2166 }, 2167 "csvImportOptions": { # Options for importing data as CSV. 2168 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 2169 "A String", 2170 ], 2171 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2172 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2173 "linesTerminatedBy": "A String", # 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. 2174 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2175 "table": "A String", # The table to which CSV data is imported. 2176 }, 2177 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 2178 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 2179 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 2180 "kind": "A String", # This is always **sql#importContext**. 2181 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 2182 }, 2183 "insertTime": "A String", # 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**. 2184 "kind": "A String", # This is always **sql#operation**. 2185 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 2186 "operationType": "A String", # 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** 2187 "selfLink": "A String", # The URI of this resource. 2188 "startTime": "A String", # 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**. 2189 "status": "A String", # The status of an operation. 2190 "targetId": "A String", # Name of the database instance related to this operation. 2191 "targetLink": "A String", 2192 "targetProject": "A String", # The project ID of the target instance related to this operation. 2193 "user": "A String", # The email address of the user who initiated this operation. 2194}</pre> 2195</div> 2196 2197<div class="method"> 2198 <code class="details" id="restart">restart(project, instance, x__xgafv=None)</code> 2199 <pre>Restarts a Cloud SQL instance. 2200 2201Args: 2202 project: string, Project ID of the project that contains the instance to be restarted. (required) 2203 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 2204 x__xgafv: string, V1 error format. 2205 Allowed values 2206 1 - v1 error format 2207 2 - v2 error format 2208 2209Returns: 2210 An object of the form: 2211 2212 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 2213 "backupContext": { # Backup context. # The context for backup operation, if applicable. 2214 "backupId": "A String", # The identifier of the backup. 2215 "kind": "A String", # This is always **sql#backupContext**. 2216 }, 2217 "endTime": "A String", # 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**. 2218 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 2219 "errors": [ # The list of errors encountered while processing this operation. 2220 { # Database instance operation error. 2221 "code": "A String", # Identifies the specific error that occurred. 2222 "kind": "A String", # This is always **sql#operationError**. 2223 "message": "A String", # Additional information about the error encountered. 2224 }, 2225 ], 2226 "kind": "A String", # This is always **sql#operationErrors**. 2227 }, 2228 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 2229 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 2230 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2231 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2232 "linesTerminatedBy": "A String", # 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. 2233 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2234 "selectQuery": "A String", # The select query used to extract the data. 2235 }, 2236 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 2237 "A String", 2238 ], 2239 "fileType": "A String", # The file type for the specified uri. 2240 "kind": "A String", # This is always **sql#exportContext**. 2241 "offload": True or False, # Option for export offload. 2242 "sqlExportOptions": { # Options for exporting data as SQL statements. 2243 "mysqlExportOptions": { # Options for exporting from MySQL. 2244 "masterData": 42, # 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. 2245 }, 2246 "schemaOnly": True or False, # Export only schemas. 2247 "tables": [ # 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. 2248 "A String", 2249 ], 2250 }, 2251 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 2252 }, 2253 "importContext": { # Database instance import context. # The context for import operation, if applicable. 2254 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 2255 "encryptionOptions": { 2256 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2257 "pvkPassword": "A String", # Password that encrypts the private key 2258 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2259 }, 2260 }, 2261 "csvImportOptions": { # Options for importing data as CSV. 2262 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 2263 "A String", 2264 ], 2265 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2266 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2267 "linesTerminatedBy": "A String", # 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. 2268 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2269 "table": "A String", # The table to which CSV data is imported. 2270 }, 2271 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 2272 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 2273 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 2274 "kind": "A String", # This is always **sql#importContext**. 2275 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 2276 }, 2277 "insertTime": "A String", # 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**. 2278 "kind": "A String", # This is always **sql#operation**. 2279 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 2280 "operationType": "A String", # 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** 2281 "selfLink": "A String", # The URI of this resource. 2282 "startTime": "A String", # 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**. 2283 "status": "A String", # The status of an operation. 2284 "targetId": "A String", # Name of the database instance related to this operation. 2285 "targetLink": "A String", 2286 "targetProject": "A String", # The project ID of the target instance related to this operation. 2287 "user": "A String", # The email address of the user who initiated this operation. 2288}</pre> 2289</div> 2290 2291<div class="method"> 2292 <code class="details" id="restoreBackup">restoreBackup(project, instance, body=None, x__xgafv=None)</code> 2293 <pre>Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart. 2294 2295Args: 2296 project: string, Project ID of the project that contains the instance. (required) 2297 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 2298 body: object, The request body. 2299 The object takes the form of: 2300 2301{ # Database instance restore backup request. 2302 "restoreBackupContext": { # Database instance restore from backup context. Backup context contains source instance id and project id. # Parameters required to perform the restore backup operation. 2303 "backupRunId": "A String", # The ID of the backup run to restore from. 2304 "instanceId": "A String", # The ID of the instance that the backup was taken from. 2305 "kind": "A String", # This is always **sql#restoreBackupContext**. 2306 "project": "A String", # The full project ID of the source instance. 2307 }, 2308} 2309 2310 x__xgafv: string, V1 error format. 2311 Allowed values 2312 1 - v1 error format 2313 2 - v2 error format 2314 2315Returns: 2316 An object of the form: 2317 2318 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 2319 "backupContext": { # Backup context. # The context for backup operation, if applicable. 2320 "backupId": "A String", # The identifier of the backup. 2321 "kind": "A String", # This is always **sql#backupContext**. 2322 }, 2323 "endTime": "A String", # 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**. 2324 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 2325 "errors": [ # The list of errors encountered while processing this operation. 2326 { # Database instance operation error. 2327 "code": "A String", # Identifies the specific error that occurred. 2328 "kind": "A String", # This is always **sql#operationError**. 2329 "message": "A String", # Additional information about the error encountered. 2330 }, 2331 ], 2332 "kind": "A String", # This is always **sql#operationErrors**. 2333 }, 2334 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 2335 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 2336 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2337 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2338 "linesTerminatedBy": "A String", # 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. 2339 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2340 "selectQuery": "A String", # The select query used to extract the data. 2341 }, 2342 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 2343 "A String", 2344 ], 2345 "fileType": "A String", # The file type for the specified uri. 2346 "kind": "A String", # This is always **sql#exportContext**. 2347 "offload": True or False, # Option for export offload. 2348 "sqlExportOptions": { # Options for exporting data as SQL statements. 2349 "mysqlExportOptions": { # Options for exporting from MySQL. 2350 "masterData": 42, # 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. 2351 }, 2352 "schemaOnly": True or False, # Export only schemas. 2353 "tables": [ # 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. 2354 "A String", 2355 ], 2356 }, 2357 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 2358 }, 2359 "importContext": { # Database instance import context. # The context for import operation, if applicable. 2360 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 2361 "encryptionOptions": { 2362 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2363 "pvkPassword": "A String", # Password that encrypts the private key 2364 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2365 }, 2366 }, 2367 "csvImportOptions": { # Options for importing data as CSV. 2368 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 2369 "A String", 2370 ], 2371 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2372 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2373 "linesTerminatedBy": "A String", # 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. 2374 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2375 "table": "A String", # The table to which CSV data is imported. 2376 }, 2377 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 2378 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 2379 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 2380 "kind": "A String", # This is always **sql#importContext**. 2381 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 2382 }, 2383 "insertTime": "A String", # 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**. 2384 "kind": "A String", # This is always **sql#operation**. 2385 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 2386 "operationType": "A String", # 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** 2387 "selfLink": "A String", # The URI of this resource. 2388 "startTime": "A String", # 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**. 2389 "status": "A String", # The status of an operation. 2390 "targetId": "A String", # Name of the database instance related to this operation. 2391 "targetLink": "A String", 2392 "targetProject": "A String", # The project ID of the target instance related to this operation. 2393 "user": "A String", # The email address of the user who initiated this operation. 2394}</pre> 2395</div> 2396 2397<div class="method"> 2398 <code class="details" id="rotateServerCa">rotateServerCa(project, instance, body=None, x__xgafv=None)</code> 2399 <pre>Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. 2400 2401Args: 2402 project: string, Project ID of the project that contains the instance. (required) 2403 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 2404 body: object, The request body. 2405 The object takes the form of: 2406 2407{ # Rotate server CA request. 2408 "rotateServerCaContext": { # Instance rotate server CA context. # Contains details about the rotate server CA operation. 2409 "kind": "A String", # This is always **sql#rotateServerCaContext**. 2410 "nextVersion": "A String", # The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server CA version. 2411 }, 2412} 2413 2414 x__xgafv: string, V1 error format. 2415 Allowed values 2416 1 - v1 error format 2417 2 - v2 error format 2418 2419Returns: 2420 An object of the form: 2421 2422 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 2423 "backupContext": { # Backup context. # The context for backup operation, if applicable. 2424 "backupId": "A String", # The identifier of the backup. 2425 "kind": "A String", # This is always **sql#backupContext**. 2426 }, 2427 "endTime": "A String", # 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**. 2428 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 2429 "errors": [ # The list of errors encountered while processing this operation. 2430 { # Database instance operation error. 2431 "code": "A String", # Identifies the specific error that occurred. 2432 "kind": "A String", # This is always **sql#operationError**. 2433 "message": "A String", # Additional information about the error encountered. 2434 }, 2435 ], 2436 "kind": "A String", # This is always **sql#operationErrors**. 2437 }, 2438 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 2439 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 2440 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2441 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2442 "linesTerminatedBy": "A String", # 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. 2443 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2444 "selectQuery": "A String", # The select query used to extract the data. 2445 }, 2446 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 2447 "A String", 2448 ], 2449 "fileType": "A String", # The file type for the specified uri. 2450 "kind": "A String", # This is always **sql#exportContext**. 2451 "offload": True or False, # Option for export offload. 2452 "sqlExportOptions": { # Options for exporting data as SQL statements. 2453 "mysqlExportOptions": { # Options for exporting from MySQL. 2454 "masterData": 42, # 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. 2455 }, 2456 "schemaOnly": True or False, # Export only schemas. 2457 "tables": [ # 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. 2458 "A String", 2459 ], 2460 }, 2461 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 2462 }, 2463 "importContext": { # Database instance import context. # The context for import operation, if applicable. 2464 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 2465 "encryptionOptions": { 2466 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2467 "pvkPassword": "A String", # Password that encrypts the private key 2468 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2469 }, 2470 }, 2471 "csvImportOptions": { # Options for importing data as CSV. 2472 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 2473 "A String", 2474 ], 2475 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2476 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2477 "linesTerminatedBy": "A String", # 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. 2478 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2479 "table": "A String", # The table to which CSV data is imported. 2480 }, 2481 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 2482 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 2483 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 2484 "kind": "A String", # This is always **sql#importContext**. 2485 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 2486 }, 2487 "insertTime": "A String", # 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**. 2488 "kind": "A String", # This is always **sql#operation**. 2489 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 2490 "operationType": "A String", # 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** 2491 "selfLink": "A String", # The URI of this resource. 2492 "startTime": "A String", # 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**. 2493 "status": "A String", # The status of an operation. 2494 "targetId": "A String", # Name of the database instance related to this operation. 2495 "targetLink": "A String", 2496 "targetProject": "A String", # The project ID of the target instance related to this operation. 2497 "user": "A String", # The email address of the user who initiated this operation. 2498}</pre> 2499</div> 2500 2501<div class="method"> 2502 <code class="details" id="startReplica">startReplica(project, instance, x__xgafv=None)</code> 2503 <pre>Starts the replication in the read replica instance. 2504 2505Args: 2506 project: string, ID of the project that contains the read replica. (required) 2507 instance: string, Cloud SQL read replica instance name. (required) 2508 x__xgafv: string, V1 error format. 2509 Allowed values 2510 1 - v1 error format 2511 2 - v2 error format 2512 2513Returns: 2514 An object of the form: 2515 2516 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 2517 "backupContext": { # Backup context. # The context for backup operation, if applicable. 2518 "backupId": "A String", # The identifier of the backup. 2519 "kind": "A String", # This is always **sql#backupContext**. 2520 }, 2521 "endTime": "A String", # 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**. 2522 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 2523 "errors": [ # The list of errors encountered while processing this operation. 2524 { # Database instance operation error. 2525 "code": "A String", # Identifies the specific error that occurred. 2526 "kind": "A String", # This is always **sql#operationError**. 2527 "message": "A String", # Additional information about the error encountered. 2528 }, 2529 ], 2530 "kind": "A String", # This is always **sql#operationErrors**. 2531 }, 2532 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 2533 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 2534 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2535 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2536 "linesTerminatedBy": "A String", # 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. 2537 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2538 "selectQuery": "A String", # The select query used to extract the data. 2539 }, 2540 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 2541 "A String", 2542 ], 2543 "fileType": "A String", # The file type for the specified uri. 2544 "kind": "A String", # This is always **sql#exportContext**. 2545 "offload": True or False, # Option for export offload. 2546 "sqlExportOptions": { # Options for exporting data as SQL statements. 2547 "mysqlExportOptions": { # Options for exporting from MySQL. 2548 "masterData": 42, # 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. 2549 }, 2550 "schemaOnly": True or False, # Export only schemas. 2551 "tables": [ # 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. 2552 "A String", 2553 ], 2554 }, 2555 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 2556 }, 2557 "importContext": { # Database instance import context. # The context for import operation, if applicable. 2558 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 2559 "encryptionOptions": { 2560 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2561 "pvkPassword": "A String", # Password that encrypts the private key 2562 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2563 }, 2564 }, 2565 "csvImportOptions": { # Options for importing data as CSV. 2566 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 2567 "A String", 2568 ], 2569 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2570 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2571 "linesTerminatedBy": "A String", # 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. 2572 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2573 "table": "A String", # The table to which CSV data is imported. 2574 }, 2575 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 2576 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 2577 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 2578 "kind": "A String", # This is always **sql#importContext**. 2579 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 2580 }, 2581 "insertTime": "A String", # 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**. 2582 "kind": "A String", # This is always **sql#operation**. 2583 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 2584 "operationType": "A String", # 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** 2585 "selfLink": "A String", # The URI of this resource. 2586 "startTime": "A String", # 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**. 2587 "status": "A String", # The status of an operation. 2588 "targetId": "A String", # Name of the database instance related to this operation. 2589 "targetLink": "A String", 2590 "targetProject": "A String", # The project ID of the target instance related to this operation. 2591 "user": "A String", # The email address of the user who initiated this operation. 2592}</pre> 2593</div> 2594 2595<div class="method"> 2596 <code class="details" id="stopReplica">stopReplica(project, instance, x__xgafv=None)</code> 2597 <pre>Stops the replication in the read replica instance. 2598 2599Args: 2600 project: string, ID of the project that contains the read replica. (required) 2601 instance: string, Cloud SQL read replica instance name. (required) 2602 x__xgafv: string, V1 error format. 2603 Allowed values 2604 1 - v1 error format 2605 2 - v2 error format 2606 2607Returns: 2608 An object of the form: 2609 2610 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 2611 "backupContext": { # Backup context. # The context for backup operation, if applicable. 2612 "backupId": "A String", # The identifier of the backup. 2613 "kind": "A String", # This is always **sql#backupContext**. 2614 }, 2615 "endTime": "A String", # 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**. 2616 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 2617 "errors": [ # The list of errors encountered while processing this operation. 2618 { # Database instance operation error. 2619 "code": "A String", # Identifies the specific error that occurred. 2620 "kind": "A String", # This is always **sql#operationError**. 2621 "message": "A String", # Additional information about the error encountered. 2622 }, 2623 ], 2624 "kind": "A String", # This is always **sql#operationErrors**. 2625 }, 2626 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 2627 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 2628 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2629 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2630 "linesTerminatedBy": "A String", # 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. 2631 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2632 "selectQuery": "A String", # The select query used to extract the data. 2633 }, 2634 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 2635 "A String", 2636 ], 2637 "fileType": "A String", # The file type for the specified uri. 2638 "kind": "A String", # This is always **sql#exportContext**. 2639 "offload": True or False, # Option for export offload. 2640 "sqlExportOptions": { # Options for exporting data as SQL statements. 2641 "mysqlExportOptions": { # Options for exporting from MySQL. 2642 "masterData": 42, # 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. 2643 }, 2644 "schemaOnly": True or False, # Export only schemas. 2645 "tables": [ # 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. 2646 "A String", 2647 ], 2648 }, 2649 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 2650 }, 2651 "importContext": { # Database instance import context. # The context for import operation, if applicable. 2652 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 2653 "encryptionOptions": { 2654 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2655 "pvkPassword": "A String", # Password that encrypts the private key 2656 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2657 }, 2658 }, 2659 "csvImportOptions": { # Options for importing data as CSV. 2660 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 2661 "A String", 2662 ], 2663 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2664 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2665 "linesTerminatedBy": "A String", # 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. 2666 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2667 "table": "A String", # The table to which CSV data is imported. 2668 }, 2669 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 2670 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 2671 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 2672 "kind": "A String", # This is always **sql#importContext**. 2673 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 2674 }, 2675 "insertTime": "A String", # 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**. 2676 "kind": "A String", # This is always **sql#operation**. 2677 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 2678 "operationType": "A String", # 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** 2679 "selfLink": "A String", # The URI of this resource. 2680 "startTime": "A String", # 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**. 2681 "status": "A String", # The status of an operation. 2682 "targetId": "A String", # Name of the database instance related to this operation. 2683 "targetLink": "A String", 2684 "targetProject": "A String", # The project ID of the target instance related to this operation. 2685 "user": "A String", # The email address of the user who initiated this operation. 2686}</pre> 2687</div> 2688 2689<div class="method"> 2690 <code class="details" id="truncateLog">truncateLog(project, instance, body=None, x__xgafv=None)</code> 2691 <pre>Truncate MySQL general and slow query log tables MySQL only. 2692 2693Args: 2694 project: string, Project ID of the Cloud SQL project. (required) 2695 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 2696 body: object, The request body. 2697 The object takes the form of: 2698 2699{ # Instance truncate log request. 2700 "truncateLogContext": { # Database Instance truncate log context. # Contains details about the truncate log operation. 2701 "kind": "A String", # This is always **sql#truncateLogContext**. 2702 "logType": "A String", # The type of log to truncate. Valid values are **MYSQL_GENERAL_TABLE** and **MYSQL_SLOW_TABLE**. 2703 }, 2704} 2705 2706 x__xgafv: string, V1 error format. 2707 Allowed values 2708 1 - v1 error format 2709 2 - v2 error format 2710 2711Returns: 2712 An object of the form: 2713 2714 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 2715 "backupContext": { # Backup context. # The context for backup operation, if applicable. 2716 "backupId": "A String", # The identifier of the backup. 2717 "kind": "A String", # This is always **sql#backupContext**. 2718 }, 2719 "endTime": "A String", # 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**. 2720 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 2721 "errors": [ # The list of errors encountered while processing this operation. 2722 { # Database instance operation error. 2723 "code": "A String", # Identifies the specific error that occurred. 2724 "kind": "A String", # This is always **sql#operationError**. 2725 "message": "A String", # Additional information about the error encountered. 2726 }, 2727 ], 2728 "kind": "A String", # This is always **sql#operationErrors**. 2729 }, 2730 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 2731 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 2732 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2733 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2734 "linesTerminatedBy": "A String", # 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. 2735 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2736 "selectQuery": "A String", # The select query used to extract the data. 2737 }, 2738 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 2739 "A String", 2740 ], 2741 "fileType": "A String", # The file type for the specified uri. 2742 "kind": "A String", # This is always **sql#exportContext**. 2743 "offload": True or False, # Option for export offload. 2744 "sqlExportOptions": { # Options for exporting data as SQL statements. 2745 "mysqlExportOptions": { # Options for exporting from MySQL. 2746 "masterData": 42, # 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. 2747 }, 2748 "schemaOnly": True or False, # Export only schemas. 2749 "tables": [ # 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. 2750 "A String", 2751 ], 2752 }, 2753 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 2754 }, 2755 "importContext": { # Database instance import context. # The context for import operation, if applicable. 2756 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 2757 "encryptionOptions": { 2758 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2759 "pvkPassword": "A String", # Password that encrypts the private key 2760 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 2761 }, 2762 }, 2763 "csvImportOptions": { # Options for importing data as CSV. 2764 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 2765 "A String", 2766 ], 2767 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 2768 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 2769 "linesTerminatedBy": "A String", # 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. 2770 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 2771 "table": "A String", # The table to which CSV data is imported. 2772 }, 2773 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 2774 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 2775 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 2776 "kind": "A String", # This is always **sql#importContext**. 2777 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 2778 }, 2779 "insertTime": "A String", # 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**. 2780 "kind": "A String", # This is always **sql#operation**. 2781 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 2782 "operationType": "A String", # 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** 2783 "selfLink": "A String", # The URI of this resource. 2784 "startTime": "A String", # 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**. 2785 "status": "A String", # The status of an operation. 2786 "targetId": "A String", # Name of the database instance related to this operation. 2787 "targetLink": "A String", 2788 "targetProject": "A String", # The project ID of the target instance related to this operation. 2789 "user": "A String", # The email address of the user who initiated this operation. 2790}</pre> 2791</div> 2792 2793<div class="method"> 2794 <code class="details" id="update">update(project, instance, body=None, x__xgafv=None)</code> 2795 <pre>Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart. 2796 2797Args: 2798 project: string, Project ID of the project that contains the instance. (required) 2799 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 2800 body: object, The request body. 2801 The object takes the form of: 2802 2803{ # A Cloud SQL instance resource. 2804 "backendType": "A String", # 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. 2805 "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. 2806 "createTime": "A String", # 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**. 2807 "currentDiskSize": "A String", # 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. 2808 "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. 2809 "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. 2810 "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. 2811 "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. 2812 "kmsKeyName": "A String", # Resource name of KMS key for disk encryption 2813 }, 2814 "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. 2815 "kind": "A String", # This is always **sql#diskEncryptionStatus**. 2816 "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource 2817 }, 2818 "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the **settings.settingsVersion** field instead. 2819 "failoverReplica": { # The name and status of the failover replica. 2820 "available": True or False, # 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. 2821 "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. 2822 }, 2823 "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. 2824 "instanceType": "A String", # The instance type. 2825 "ipAddresses": [ # The assigned IP addresses for the instance. 2826 { # Database instance IP Mapping. 2827 "ipAddress": "A String", # The IP address assigned. 2828 "timeToRetire": "A String", # 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. 2829 "type": "A String", # 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. 2830 }, 2831 ], 2832 "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. 2833 "kind": "A String", # This is always **sql#instance**. 2834 "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup. 2835 "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. 2836 "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. 2837 "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances. 2838 "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. 2839 "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. 2840 "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. 2841 "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. 2842 "hostPort": "A String", # The host and port of the on-premises instance in host:port format 2843 "kind": "A String", # This is always **sql#onPremisesConfiguration**. 2844 "password": "A String", # The password for connecting to on-premises instance. 2845 "sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL. 2846 "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. 2847 "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. 2848 "region": "A String", # The region of the Cloud SQL instance being referenced. 2849 }, 2850 "username": "A String", # The username for connecting to on-premises instance. 2851 }, 2852 "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # 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 2853 "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers: 2854 "sqlOutOfDiskState": "A String", # 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 2855 }, 2856 "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. 2857 "region": "A String", # The geographical region. Can be: * **us-central** (**FIRST_GEN** instances only) * **us-central1** (**SECOND_GEN** instances only) * **asia-east1** or **europe-west1**. Defaults to **us-central** or **us-central1** depending on the instance type. The region cannot be changed after instance creation. 2858 "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. 2859 "failoverTarget": True or False, # 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. 2860 "kind": "A String", # This is always **sql#replicaConfiguration**. 2861 "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # 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. 2862 "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. 2863 "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. 2864 "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. 2865 "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds. 2866 "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump. 2867 "kind": "A String", # This is always **sql#mysqlReplicaConfiguration**. 2868 "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats. 2869 "password": "A String", # The password for the replication connection. 2870 "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption. 2871 "username": "A String", # The username for the replication connection. 2872 "verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake. 2873 }, 2874 }, 2875 "replicaNames": [ # The replicas of the instance. 2876 "A String", 2877 ], 2878 "rootPassword": "A String", # Initial root password. Use only on creation. 2879 "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use. 2880 "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance. 2881 "canDefer": True or False, 2882 "canReschedule": True or False, # If the scheduled maintenance can be rescheduled. 2883 "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline. 2884 "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance. 2885 }, 2886 "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use. 2887 "selfLink": "A String", # The URI of this resource. 2888 "serverCaCert": { # SslCerts Resource # SSL configuration. 2889 "cert": "A String", # PEM representation. 2890 "certSerialNumber": "A String", # Serial number, as extracted from the certificate. 2891 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+. 2892 "createTime": "A String", # 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** 2893 "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 2894 "instance": "A String", # Name of the database instance. 2895 "kind": "A String", # This is always **sql#sslCert**. 2896 "selfLink": "A String", # The URI of this resource. 2897 "sha1Fingerprint": "A String", # Sha1 Fingerprint. 2898 }, 2899 "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only. 2900 "settings": { # Database instance settings. # The user settings. 2901 "activationPolicy": "A String", # 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. 2902 "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server. 2903 "domain": "A String", # The name of the domain (e.g., mydomain.com). 2904 "kind": "A String", # This is always sql#activeDirectoryConfig. 2905 }, 2906 "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only. 2907 "A String", 2908 ], 2909 "availabilityType": "A String", # 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). 2910 "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance. 2911 "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings. 2912 "retainedBackups": 42, # 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. 2913 "retentionUnit": "A String", # The unit that 'retained_backups' represents. 2914 }, 2915 "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. 2916 "enabled": True or False, # Whether this configuration is enabled. 2917 "kind": "A String", # This is always **sql#backupConfiguration**. 2918 "location": "A String", # Location of the backup 2919 "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled. 2920 "replicationLogArchivingEnabled": True or False, # Reserved for future use. 2921 "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - **HH:MM**. 2922 "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. 2923 }, 2924 "collation": "A String", # The name of server Instance collation. 2925 "crashSafeReplicationEnabled": True or False, # 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. 2926 "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. 2927 "dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**. Not used for First Generation instances. 2928 "databaseFlags": [ # The database flags passed to the instance at startup. 2929 { # Database flags for Cloud SQL instances. 2930 "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation. 2931 "value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. 2932 }, 2933 ], 2934 "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. 2935 "denyMaintenancePeriods": [ # Deny maintenance periods 2936 { # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied. 2937 "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 2938 "startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the 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 2939 "time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00 2940 }, 2941 ], 2942 "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. 2943 "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. 2944 "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. 2945 "queryStringLength": 42, # 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. 2946 "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled. 2947 "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled. 2948 }, 2949 "ipConfiguration": { # IP Management configuration. # 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. 2950 "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](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])?.` 2951 "authorizedNetworks": [ # 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**). 2952 { # An entry for an Access Control list. 2953 "expirationTime": "A String", # 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**. 2954 "kind": "A String", # This is always **sql#aclEntry**. 2955 "name": "A String", # Optional. A label to identify this entry. 2956 "value": "A String", # The allowlisted value for the access control list. 2957 }, 2958 ], 2959 "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not. 2960 "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, **/projects/myProject/global/networks/default**. This setting can be updated, but it cannot be removed after it is set. 2961 "requireSsl": True or False, # Whether SSL connections over IP are enforced or not. 2962 }, 2963 "kind": "A String", # This is always **sql#settings**. 2964 "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # 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. 2965 "followGaeApplication": "A String", # 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. 2966 "kind": "A String", # This is always **sql#locationPreference**. 2967 "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. 2968 "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. 2969 }, 2970 "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. 2971 "day": 42, # day of week (1-7), starting on Monday. 2972 "hour": 42, # hour of day - 0 to 23. 2973 "kind": "A String", # This is always **sql#maintenanceWindow**. 2974 "updateTrack": "A String", # Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more](https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen). 2975 }, 2976 "passwordValidationPolicy": { # Database instance local user password validation policy # The local user password validation policy of the instance. 2977 "complexity": "A String", # The complexity of the password. 2978 "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. 2979 "minLength": 42, # Minimum number of characters allowed. 2980 "passwordChangeInterval": "A String", # Minimum interval after which the password can be changed. 2981 "reuseInterval": 42, # Number of previous passwords that cannot be reused. 2982 }, 2983 "pricingPlan": "A String", # The pricing plan for this instance. This can be either **PER_USE** or **PACKAGE**. Only **PER_USE** is supported for Second Generation instances. 2984 "replicationType": "A String", # The type of replication this instance uses. This can be either **ASYNCHRONOUS** or **SYNCHRONOUS**. (Deprecated) This property was only applicable to First Generation instances. 2985 "settingsVersion": "A String", # 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. 2986 "sqlServerAuditConfig": { # SQL Server specific audit configuration. # SQL Server specific audit configuration. 2987 "bucket": "A String", # The name of the destination bucket (e.g., gs://mybucket). 2988 "kind": "A String", # This is always sql#sqlServerAuditConfig 2989 }, 2990 "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. 2991 "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. 2992 "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. 2993 "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. 2994 "a_key": "A String", 2995 }, 2996 }, 2997 "state": "A String", # The current serving state of the Cloud SQL instance. 2998 "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. 2999 "A String", 3000 ], 3001} 3002 3003 x__xgafv: string, V1 error format. 3004 Allowed values 3005 1 - v1 error format 3006 2 - v2 error format 3007 3008Returns: 3009 An object of the form: 3010 3011 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 3012 "backupContext": { # Backup context. # The context for backup operation, if applicable. 3013 "backupId": "A String", # The identifier of the backup. 3014 "kind": "A String", # This is always **sql#backupContext**. 3015 }, 3016 "endTime": "A String", # 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**. 3017 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 3018 "errors": [ # The list of errors encountered while processing this operation. 3019 { # Database instance operation error. 3020 "code": "A String", # Identifies the specific error that occurred. 3021 "kind": "A String", # This is always **sql#operationError**. 3022 "message": "A String", # Additional information about the error encountered. 3023 }, 3024 ], 3025 "kind": "A String", # This is always **sql#operationErrors**. 3026 }, 3027 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 3028 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 3029 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 3030 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 3031 "linesTerminatedBy": "A String", # 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. 3032 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 3033 "selectQuery": "A String", # The select query used to extract the data. 3034 }, 3035 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 3036 "A String", 3037 ], 3038 "fileType": "A String", # The file type for the specified uri. 3039 "kind": "A String", # This is always **sql#exportContext**. 3040 "offload": True or False, # Option for export offload. 3041 "sqlExportOptions": { # Options for exporting data as SQL statements. 3042 "mysqlExportOptions": { # Options for exporting from MySQL. 3043 "masterData": 42, # 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. 3044 }, 3045 "schemaOnly": True or False, # Export only schemas. 3046 "tables": [ # 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. 3047 "A String", 3048 ], 3049 }, 3050 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 3051 }, 3052 "importContext": { # Database instance import context. # The context for import operation, if applicable. 3053 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 3054 "encryptionOptions": { 3055 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 3056 "pvkPassword": "A String", # Password that encrypts the private key 3057 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 3058 }, 3059 }, 3060 "csvImportOptions": { # Options for importing data as CSV. 3061 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 3062 "A String", 3063 ], 3064 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 3065 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 3066 "linesTerminatedBy": "A String", # 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. 3067 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 3068 "table": "A String", # The table to which CSV data is imported. 3069 }, 3070 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 3071 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 3072 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 3073 "kind": "A String", # This is always **sql#importContext**. 3074 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 3075 }, 3076 "insertTime": "A String", # 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**. 3077 "kind": "A String", # This is always **sql#operation**. 3078 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. 3079 "operationType": "A String", # 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** 3080 "selfLink": "A String", # The URI of this resource. 3081 "startTime": "A String", # 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**. 3082 "status": "A String", # The status of an operation. 3083 "targetId": "A String", # Name of the database instance related to this operation. 3084 "targetLink": "A String", 3085 "targetProject": "A String", # The project ID of the target instance related to this operation. 3086 "user": "A String", # The email address of the user who initiated this operation. 3087}</pre> 3088</div> 3089 3090</body></html>