| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="sqladmin_v1.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1.projects.html">projects</a> . <a href="sqladmin_v1.projects.instances.html">instances</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#getDiskShrinkConfig">getDiskShrinkConfig(project, instance, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Get Disk Shrink Config for a given instance.</p> | |
| <p class="toc_element"> | |
| <code><a href="#getLatestRecoveryTime">getLatestRecoveryTime(project, instance, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Get Latest Recovery Time for a given instance.</p> | |
| <p class="toc_element"> | |
| <code><a href="#performDiskShrink">performDiskShrink(project, instance, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Perform Disk Shrink on primary instance.</p> | |
| <p class="toc_element"> | |
| <code><a href="#rescheduleMaintenance">rescheduleMaintenance(project, instance, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Reschedules the maintenance on the given instance.</p> | |
| <p class="toc_element"> | |
| <code><a href="#resetReplicaSize">resetReplicaSize(project, instance, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Reset Replica Size to primary instance disk size.</p> | |
| <p class="toc_element"> | |
| <code><a href="#startExternalSync">startExternalSync(project, instance, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Start External primary instance migration.</p> | |
| <p class="toc_element"> | |
| <code><a href="#verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Verify External primary instance external sync settings.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="getDiskShrinkConfig">getDiskShrinkConfig(project, instance, x__xgafv=None)</code> | |
| <pre>Get Disk Shrink Config for a given instance. | |
| Args: | |
| project: string, Project ID of the project that contains the instance. (required) | |
| instance: string, Cloud SQL instance ID. This does not include the project ID. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Instance get disk shrink config response. | |
| "kind": "A String", # This is always `sql#getDiskShrinkConfig`. | |
| "message": "A String", # Additional message to customers. | |
| "minimalTargetSizeGb": "A String", # The minimum size to which a disk can be shrunk in GigaBytes. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="getLatestRecoveryTime">getLatestRecoveryTime(project, instance, x__xgafv=None)</code> | |
| <pre>Get Latest Recovery Time for a given instance. | |
| Args: | |
| project: string, Project ID of the project that contains the instance. (required) | |
| instance: string, Cloud SQL instance ID. This does not include the project ID. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Instance get latest recovery time response. | |
| "kind": "A String", # This is always `sql#getLatestRecoveryTime`. | |
| "latestRecoveryTime": "A String", # Timestamp, identifies the latest recovery time of the source instance. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="performDiskShrink">performDiskShrink(project, instance, body=None, x__xgafv=None)</code> | |
| <pre>Perform Disk Shrink on primary instance. | |
| Args: | |
| project: string, Project ID of the project that contains the instance. (required) | |
| instance: string, Cloud SQL instance ID. This does not include the project ID. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Perform disk shrink context. | |
| "targetSizeGb": "A String", # The target disk shrink size in GigaBytes. | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | |
| "apiWarning": { # An Admin API warning message. # An Admin API warning message. | |
| "code": "A String", # Code to uniquely identify the warning type. | |
| "message": "A String", # The warning message. | |
| "region": "A String", # The region name for REGION_UNREACHABLE warning. | |
| }, | |
| "backupContext": { # Backup context. # The context for backup operation, if applicable. | |
| "backupId": "A String", # The identifier of the backup. | |
| "kind": "A String", # This is always `sql#backupContext`. | |
| }, | |
| "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`. | |
| "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. | |
| "errors": [ # The list of errors encountered while processing this operation. | |
| { # Database instance operation error. | |
| "code": "A String", # Identifies the specific error that occurred. | |
| "kind": "A String", # This is always `sql#operationError`. | |
| "message": "A String", # Additional information about the error encountered. | |
| }, | |
| ], | |
| "kind": "A String", # This is always `sql#operationErrors`. | |
| }, | |
| "exportContext": { # Database instance export context. # The context for export operation, if applicable. | |
| "bakExportOptions": { # Options for exporting BAK files (SQL Server-only) | |
| "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only | |
| "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead | |
| "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base | |
| "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen. | |
| "striped": True or False, # Whether or not the export should be striped. | |
| }, | |
| "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only. | |
| "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. | |
| "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. | |
| "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. | |
| "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. | |
| "selectQuery": "A String", # The select query used to extract the data. | |
| }, | |
| "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`. | |
| "A String", | |
| ], | |
| "fileType": "A String", # The file type for the specified uri. | |
| "kind": "A String", # This is always `sql#exportContext`. | |
| "offload": True or False, # Option for export offload. | |
| "sqlExportOptions": { # Options for exporting data as SQL statements. | |
| "mysqlExportOptions": { # Options for exporting from MySQL. | |
| "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. | |
| }, | |
| "schemaOnly": True or False, # Export only schemas. | |
| "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. | |
| "A String", | |
| ], | |
| }, | |
| "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. | |
| }, | |
| "importContext": { # Database instance import context. # The context for import operation, if applicable. | |
| "bakImportOptions": { # Import parameters specific to SQL Server .BAK files | |
| "bakType": "A String", # Type of the bak content, FULL or DIFF | |
| "encryptionOptions": { | |
| "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. | |
| "pvkPassword": "A String", # Password that encrypts the private key | |
| "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. | |
| }, | |
| "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server. | |
| "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server. | |
| "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only. | |
| "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only. | |
| "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server. | |
| }, | |
| "csvImportOptions": { # Options for importing data as CSV. | |
| "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. | |
| "A String", | |
| ], | |
| "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. | |
| "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. | |
| "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. | |
| "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. | |
| "table": "A String", # The table to which CSV data is imported. | |
| }, | |
| "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. | |
| "fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data. | |
| "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. | |
| "kind": "A String", # This is always `sql#importContext`. | |
| "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. | |
| }, | |
| "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`. | |
| "kind": "A String", # This is always `sql#operation`. | |
| "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. | |
| "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` | |
| "selfLink": "A String", # The URI of this resource. | |
| "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`. | |
| "status": "A String", # The status of an operation. | |
| "targetId": "A String", # Name of the database instance related to this operation. | |
| "targetLink": "A String", | |
| "targetProject": "A String", # The project ID of the target instance related to this operation. | |
| "user": "A String", # The email address of the user who initiated this operation. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="rescheduleMaintenance">rescheduleMaintenance(project, instance, body=None, x__xgafv=None)</code> | |
| <pre>Reschedules the maintenance on the given instance. | |
| Args: | |
| project: string, ID of the project that contains the instance. (required) | |
| instance: string, Cloud SQL instance ID. This does not include the project ID. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Reschedule options for maintenance windows. | |
| "reschedule": { # Required. The type of the reschedule the user wants. | |
| "rescheduleType": "A String", # Required. The type of the reschedule. | |
| "scheduleTime": "A String", # Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | |
| }, | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | |
| "apiWarning": { # An Admin API warning message. # An Admin API warning message. | |
| "code": "A String", # Code to uniquely identify the warning type. | |
| "message": "A String", # The warning message. | |
| "region": "A String", # The region name for REGION_UNREACHABLE warning. | |
| }, | |
| "backupContext": { # Backup context. # The context for backup operation, if applicable. | |
| "backupId": "A String", # The identifier of the backup. | |
| "kind": "A String", # This is always `sql#backupContext`. | |
| }, | |
| "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`. | |
| "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. | |
| "errors": [ # The list of errors encountered while processing this operation. | |
| { # Database instance operation error. | |
| "code": "A String", # Identifies the specific error that occurred. | |
| "kind": "A String", # This is always `sql#operationError`. | |
| "message": "A String", # Additional information about the error encountered. | |
| }, | |
| ], | |
| "kind": "A String", # This is always `sql#operationErrors`. | |
| }, | |
| "exportContext": { # Database instance export context. # The context for export operation, if applicable. | |
| "bakExportOptions": { # Options for exporting BAK files (SQL Server-only) | |
| "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only | |
| "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead | |
| "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base | |
| "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen. | |
| "striped": True or False, # Whether or not the export should be striped. | |
| }, | |
| "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only. | |
| "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. | |
| "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. | |
| "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. | |
| "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. | |
| "selectQuery": "A String", # The select query used to extract the data. | |
| }, | |
| "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`. | |
| "A String", | |
| ], | |
| "fileType": "A String", # The file type for the specified uri. | |
| "kind": "A String", # This is always `sql#exportContext`. | |
| "offload": True or False, # Option for export offload. | |
| "sqlExportOptions": { # Options for exporting data as SQL statements. | |
| "mysqlExportOptions": { # Options for exporting from MySQL. | |
| "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. | |
| }, | |
| "schemaOnly": True or False, # Export only schemas. | |
| "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. | |
| "A String", | |
| ], | |
| }, | |
| "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. | |
| }, | |
| "importContext": { # Database instance import context. # The context for import operation, if applicable. | |
| "bakImportOptions": { # Import parameters specific to SQL Server .BAK files | |
| "bakType": "A String", # Type of the bak content, FULL or DIFF | |
| "encryptionOptions": { | |
| "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. | |
| "pvkPassword": "A String", # Password that encrypts the private key | |
| "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. | |
| }, | |
| "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server. | |
| "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server. | |
| "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only. | |
| "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only. | |
| "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server. | |
| }, | |
| "csvImportOptions": { # Options for importing data as CSV. | |
| "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. | |
| "A String", | |
| ], | |
| "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. | |
| "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. | |
| "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. | |
| "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. | |
| "table": "A String", # The table to which CSV data is imported. | |
| }, | |
| "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. | |
| "fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data. | |
| "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. | |
| "kind": "A String", # This is always `sql#importContext`. | |
| "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. | |
| }, | |
| "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`. | |
| "kind": "A String", # This is always `sql#operation`. | |
| "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. | |
| "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` | |
| "selfLink": "A String", # The URI of this resource. | |
| "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`. | |
| "status": "A String", # The status of an operation. | |
| "targetId": "A String", # Name of the database instance related to this operation. | |
| "targetLink": "A String", | |
| "targetProject": "A String", # The project ID of the target instance related to this operation. | |
| "user": "A String", # The email address of the user who initiated this operation. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="resetReplicaSize">resetReplicaSize(project, instance, body=None, x__xgafv=None)</code> | |
| <pre>Reset Replica Size to primary instance disk size. | |
| Args: | |
| project: string, ID of the project that contains the read replica. (required) | |
| instance: string, Cloud SQL read replica instance name. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Instance reset replica size request. | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | |
| "apiWarning": { # An Admin API warning message. # An Admin API warning message. | |
| "code": "A String", # Code to uniquely identify the warning type. | |
| "message": "A String", # The warning message. | |
| "region": "A String", # The region name for REGION_UNREACHABLE warning. | |
| }, | |
| "backupContext": { # Backup context. # The context for backup operation, if applicable. | |
| "backupId": "A String", # The identifier of the backup. | |
| "kind": "A String", # This is always `sql#backupContext`. | |
| }, | |
| "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`. | |
| "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. | |
| "errors": [ # The list of errors encountered while processing this operation. | |
| { # Database instance operation error. | |
| "code": "A String", # Identifies the specific error that occurred. | |
| "kind": "A String", # This is always `sql#operationError`. | |
| "message": "A String", # Additional information about the error encountered. | |
| }, | |
| ], | |
| "kind": "A String", # This is always `sql#operationErrors`. | |
| }, | |
| "exportContext": { # Database instance export context. # The context for export operation, if applicable. | |
| "bakExportOptions": { # Options for exporting BAK files (SQL Server-only) | |
| "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only | |
| "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead | |
| "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base | |
| "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen. | |
| "striped": True or False, # Whether or not the export should be striped. | |
| }, | |
| "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only. | |
| "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. | |
| "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. | |
| "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. | |
| "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. | |
| "selectQuery": "A String", # The select query used to extract the data. | |
| }, | |
| "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`. | |
| "A String", | |
| ], | |
| "fileType": "A String", # The file type for the specified uri. | |
| "kind": "A String", # This is always `sql#exportContext`. | |
| "offload": True or False, # Option for export offload. | |
| "sqlExportOptions": { # Options for exporting data as SQL statements. | |
| "mysqlExportOptions": { # Options for exporting from MySQL. | |
| "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. | |
| }, | |
| "schemaOnly": True or False, # Export only schemas. | |
| "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. | |
| "A String", | |
| ], | |
| }, | |
| "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. | |
| }, | |
| "importContext": { # Database instance import context. # The context for import operation, if applicable. | |
| "bakImportOptions": { # Import parameters specific to SQL Server .BAK files | |
| "bakType": "A String", # Type of the bak content, FULL or DIFF | |
| "encryptionOptions": { | |
| "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. | |
| "pvkPassword": "A String", # Password that encrypts the private key | |
| "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. | |
| }, | |
| "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server. | |
| "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server. | |
| "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only. | |
| "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only. | |
| "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server. | |
| }, | |
| "csvImportOptions": { # Options for importing data as CSV. | |
| "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. | |
| "A String", | |
| ], | |
| "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. | |
| "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. | |
| "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. | |
| "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. | |
| "table": "A String", # The table to which CSV data is imported. | |
| }, | |
| "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. | |
| "fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data. | |
| "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. | |
| "kind": "A String", # This is always `sql#importContext`. | |
| "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. | |
| }, | |
| "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`. | |
| "kind": "A String", # This is always `sql#operation`. | |
| "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. | |
| "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` | |
| "selfLink": "A String", # The URI of this resource. | |
| "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`. | |
| "status": "A String", # The status of an operation. | |
| "targetId": "A String", # Name of the database instance related to this operation. | |
| "targetLink": "A String", | |
| "targetProject": "A String", # The project ID of the target instance related to this operation. | |
| "user": "A String", # The email address of the user who initiated this operation. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="startExternalSync">startExternalSync(project, instance, body=None, x__xgafv=None)</code> | |
| <pre>Start External primary instance migration. | |
| Args: | |
| project: string, ID of the project that contains the instance. (required) | |
| instance: string, Cloud SQL instance ID. This does not include the project ID. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Instance start external sync request. | |
| "mysqlSyncConfig": { # MySQL-specific external server sync settings. # MySQL-specific settings for start external sync. | |
| "initialSyncFlags": [ # Flags to use for the initial dump. | |
| { # Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump. | |
| "name": "A String", # The name of the flag. | |
| "value": "A String", # The value of the flag. This field must be omitted if the flag doesn't take a value. | |
| }, | |
| ], | |
| }, | |
| "skipVerification": True or False, # Whether to skip the verification step (VESS). | |
| "syncMode": "A String", # External sync mode. | |
| "syncParallelLevel": "A String", # Optional. Parallel level for initial data sync. Currently only applicable for MySQL. | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | |
| "apiWarning": { # An Admin API warning message. # An Admin API warning message. | |
| "code": "A String", # Code to uniquely identify the warning type. | |
| "message": "A String", # The warning message. | |
| "region": "A String", # The region name for REGION_UNREACHABLE warning. | |
| }, | |
| "backupContext": { # Backup context. # The context for backup operation, if applicable. | |
| "backupId": "A String", # The identifier of the backup. | |
| "kind": "A String", # This is always `sql#backupContext`. | |
| }, | |
| "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`. | |
| "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. | |
| "errors": [ # The list of errors encountered while processing this operation. | |
| { # Database instance operation error. | |
| "code": "A String", # Identifies the specific error that occurred. | |
| "kind": "A String", # This is always `sql#operationError`. | |
| "message": "A String", # Additional information about the error encountered. | |
| }, | |
| ], | |
| "kind": "A String", # This is always `sql#operationErrors`. | |
| }, | |
| "exportContext": { # Database instance export context. # The context for export operation, if applicable. | |
| "bakExportOptions": { # Options for exporting BAK files (SQL Server-only) | |
| "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only | |
| "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead | |
| "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base | |
| "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen. | |
| "striped": True or False, # Whether or not the export should be striped. | |
| }, | |
| "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only. | |
| "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. | |
| "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. | |
| "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. | |
| "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. | |
| "selectQuery": "A String", # The select query used to extract the data. | |
| }, | |
| "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`. | |
| "A String", | |
| ], | |
| "fileType": "A String", # The file type for the specified uri. | |
| "kind": "A String", # This is always `sql#exportContext`. | |
| "offload": True or False, # Option for export offload. | |
| "sqlExportOptions": { # Options for exporting data as SQL statements. | |
| "mysqlExportOptions": { # Options for exporting from MySQL. | |
| "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. | |
| }, | |
| "schemaOnly": True or False, # Export only schemas. | |
| "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. | |
| "A String", | |
| ], | |
| }, | |
| "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. | |
| }, | |
| "importContext": { # Database instance import context. # The context for import operation, if applicable. | |
| "bakImportOptions": { # Import parameters specific to SQL Server .BAK files | |
| "bakType": "A String", # Type of the bak content, FULL or DIFF | |
| "encryptionOptions": { | |
| "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. | |
| "pvkPassword": "A String", # Password that encrypts the private key | |
| "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. | |
| }, | |
| "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server. | |
| "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server. | |
| "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only. | |
| "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only. | |
| "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server. | |
| }, | |
| "csvImportOptions": { # Options for importing data as CSV. | |
| "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. | |
| "A String", | |
| ], | |
| "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. | |
| "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. | |
| "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. | |
| "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. | |
| "table": "A String", # The table to which CSV data is imported. | |
| }, | |
| "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. | |
| "fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data. | |
| "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. | |
| "kind": "A String", # This is always `sql#importContext`. | |
| "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. | |
| }, | |
| "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`. | |
| "kind": "A String", # This is always `sql#operation`. | |
| "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. | |
| "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` | |
| "selfLink": "A String", # The URI of this resource. | |
| "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`. | |
| "status": "A String", # The status of an operation. | |
| "targetId": "A String", # Name of the database instance related to this operation. | |
| "targetLink": "A String", | |
| "targetProject": "A String", # The project ID of the target instance related to this operation. | |
| "user": "A String", # The email address of the user who initiated this operation. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, body=None, x__xgafv=None)</code> | |
| <pre>Verify External primary instance external sync settings. | |
| Args: | |
| project: string, Project ID of the project that contains the instance. (required) | |
| instance: string, Cloud SQL instance ID. This does not include the project ID. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Instance verify external sync settings request. | |
| "mysqlSyncConfig": { # MySQL-specific external server sync settings. # Optional. MySQL-specific settings for start external sync. | |
| "initialSyncFlags": [ # Flags to use for the initial dump. | |
| { # Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump. | |
| "name": "A String", # The name of the flag. | |
| "value": "A String", # The value of the flag. This field must be omitted if the flag doesn't take a value. | |
| }, | |
| ], | |
| }, | |
| "syncMode": "A String", # External sync mode | |
| "verifyConnectionOnly": True or False, # Flag to enable verifying connection only | |
| "verifyReplicationOnly": True or False, # Optional. Flag to verify settings required by replication setup only | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Instance verify external sync settings response. | |
| "errors": [ # List of migration violations. | |
| { # External primary instance migration setting error/warning. | |
| "detail": "A String", # Additional information about the error encountered. | |
| "kind": "A String", # Can be `sql#externalSyncSettingError` or `sql#externalSyncSettingWarning`. | |
| "type": "A String", # Identifies the specific error that occurred. | |
| }, | |
| ], | |
| "kind": "A String", # This is always `sql#migrationSettingErrorList`. | |
| "warnings": [ # List of migration warnings. | |
| { # External primary instance migration setting error/warning. | |
| "detail": "A String", # Additional information about the error encountered. | |
| "kind": "A String", # Can be `sql#externalSyncSettingError` or `sql#externalSyncSettingWarning`. | |
| "type": "A String", # Identifies the specific error that occurred. | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| </body></html> |