chore: update docs/dyn (#1106)
diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html
index ce73627..e63aba1 100644
--- a/docs/dyn/sqladmin_v1beta4.instances.html
+++ b/docs/dyn/sqladmin_v1beta4.instances.html
@@ -105,7 +105,7 @@
<code><a href="#insert">insert(project, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Cloud SQL instance.</p>
<p class="toc_element">
- <code><a href="#list">list(project, filter=None, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(project, maxResults=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists instances under a given project.</p>
<p class="toc_element">
<code><a href="#listServerCas">listServerCas(project, instance, x__xgafv=None)</a></code></p>
@@ -159,10 +159,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -170,49 +171,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -220,9 +181,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -238,14 +242,14 @@
{ # Database instance clone request.
"cloneContext": { # Database instance clone context. # Contains details about the clone operation.
+ "kind": "A String", # This is always *sql#cloneContext*.
+ "pitrTimestampMs": "A String", # Reserved for future use.
+ "pointInTime": "A String", # Reserved for future use.
"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.
- "kind": "A String", # This is always *sql#binLogCoordinates*.
"binLogFileName": "A String", # Name of the binary log file for a Cloud SQL instance.
"binLogPosition": "A String", # Position (offset) within the binary log file.
+ "kind": "A String", # This is always *sql#binLogCoordinates*.
},
- "pointInTime": "A String", # Reserved for future use.
- "pitrTimestampMs": "A String", # Reserved for future use.
- "kind": "A String", # This is always *sql#cloneContext*.
"destinationInstanceName": "A String", # Name of the Cloud SQL instance to be created as a clone.
},
}
@@ -258,10 +262,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -269,49 +274,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -319,9 +284,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -345,10 +353,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -356,49 +365,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -406,9 +375,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -424,19 +436,19 @@
{ # Database demote primary instance request.
"demoteMasterContext": { # Database instance demote primary instance context. # Contains details about the demoteMaster operation.
- "replicaConfiguration": { # Read-replica configuration for connecting to the on-premises primary instance. # Configuration specific to read-replicas replicating from the on-premises primary instance.
- "kind": "A String", # This is always *sql#demoteMasterConfiguration*.
- "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.
- "password": "A String", # The password for the replication connection.
- "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.
- "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
- "username": "A String", # The username for the replication connection.
- "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
- "kind": "A String", # This is always *sql#demoteMasterMysqlReplicaConfiguration*.
- },
- },
"kind": "A String", # This is always *sql#demoteMasterContext*.
"masterInstanceName": "A String", # The name of the instance which will act as on-premises primary instance in the replication setup.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the on-premises primary instance. # Configuration specific to read-replicas replicating from the on-premises primary instance.
+ "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.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "password": "A String", # The password for the replication connection.
+ "kind": "A String", # This is always *sql#demoteMasterMysqlReplicaConfiguration*.
+ "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.
+ "username": "A String", # The username for the replication connection.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ },
+ "kind": "A String", # This is always *sql#demoteMasterConfiguration*.
+ },
"verifyGtidConsistency": True or False, # Verify GTID consistency for demote operation. Default value: *True*. Second Generation instances only. 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.
},
}
@@ -449,10 +461,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -460,49 +473,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -510,9 +483,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -528,25 +544,25 @@
{ # Database instance export request.
"exportContext": { # Database instance export context. # Contains details about the export operation.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
"sqlExportOptions": { # Options for exporting data as SQL statements.
"schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
"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",
],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
},
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
"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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
},
}
@@ -558,10 +574,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -569,49 +586,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -619,9 +596,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -650,10 +670,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -661,49 +682,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -711,9 +692,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -733,172 +757,178 @@
An object of the form:
{ # A Cloud SQL instance resource. Next field: 36
- "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
- "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.
- "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.
- "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.
- "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
- "password": "A String", # The password for connecting to on-premises instance.
- "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
- "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
- "kind": "A String", # This is always *sql#onPremisesConfiguration*.
- "hostPort": "A String", # The host and port of the on-premises instance in host:port format
- "username": "A String", # The username for connecting to on-premises instance.
- "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
- "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
+ "canDefer": True or False,
+ "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
+ "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
},
- "instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.
- "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
- "kind": "A String", # This is always *sql#diskEncryptionConfiguration*.
- "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
- },
- "rootPassword": "A String", # Initial root password. Use only on creation.
+ "backendType": "A String", # *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.
"failoverReplica": { # The name and status of the failover replica. This property is applicable only to Second Generation instances.
"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.
"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. This property is applicable only to Second Generation instances.
},
- "serverCaCert": { # SslCerts Resource # SSL configuration.
- "kind": "A String", # This is always *sql#sslCert*.
- "instance": "A String", # Name of the database instance.
- "cert": "A String", # PEM representation.
- "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
- "sha1Fingerprint": "A String", # Sha1 Fingerprint.
- "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
- "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
- "selfLink": "A String", # The URI of this resource.
- "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- },
"databaseVersion": "A String", # The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11* or *POSTGRES_12* (default). SQL Server instances: *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.
- "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.
"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
"A String",
],
- "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
- "selfLink": "A String", # The URI of this resource.
+ "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.
+ "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "username": "A String", # The username for connecting to on-premises instance.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "kind": "A String", # This is always *sql#onPremisesConfiguration*.
+ "password": "A String", # The password for connecting to on-premises instance.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
+ },
"ipAddresses": [ # The assigned IP addresses for the instance.
{ # Database instance IP Mapping.
"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.
- "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.
"ipAddress": "A String", # The IP address assigned.
+ "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.
},
],
- "satisfiesPzs": True or False, # The status indicating if instance satisfies physical zone separation. Reserved for future use.
- "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.
- "backendType": "A String", # *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.
- "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 for details.
- "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance has been stopped by owner. It is not currently running, but it's ready to be restarted. *SUSPENDED*: The instance is not available, for example due to problems with billing. for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.
- "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
- "settings": { # Database instance settings. # The user settings.
- "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.
- "kind": "A String", # This is always *sql#settings*.
- "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.
- "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.
- "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.
- "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.
- "dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
- "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
- "enabled": True or False, # Whether this configuration is enabled.
- "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.
- "retentionUnit": "A String", # The unit that 'retained_backups' represents.
- "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.
- },
- "kind": "A String", # This is always *sql#backupConfiguration*.
- "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.
- "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
- "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.
- "replicationLogArchivingEnabled": True or False, # Reserved for future use.
- "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
- "location": "A String", # Location of the backup
- },
- "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. 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.
- "kind": "A String", # This is always *sql#locationPreference*.
- "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
- "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
- "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.
- },
- "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.
- "tier": "A String", # The tier (or machine type) for this instance, for example *db-n1-standard-1* (MySQL instances) or *db-custom-1-3840* (PostgreSQL instances).
- "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.
- "collation": "A String", # The name of server Instance collation.
- "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.
- "day": 42, # day of week (1-7), starting on Monday.
- "kind": "A String", # This is always *sql#maintenanceWindow*.
- "hour": 42, # hour of day - 0 to 23.
- "updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.
- },
- "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.
- "a_key": "A String",
- },
- "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.
- "databaseFlags": [ # The database flags passed to the instance at startup.
- { # Database flags for Cloud SQL instances.
- "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.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
- },
- ],
- "denyMaintenancePeriods": [ # Deny maintenance periods
- { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.
- "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 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
- "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
- "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
- },
- ],
- "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
- "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.
- "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.
- "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: *192.168.100.0/24*).
- { # An entry for an Access Control list.
- "kind": "A String", # This is always *sql#aclEntry*.
- "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "name": "A String", # Optional. A label to identify this entry.
- "value": "A String", # The allowlisted value for the access control list.
- },
- ],
- "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.
- "requireSsl": True or False, # Whether SSL connections over IP are enforced or not.
- },
- "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
- "A String",
- ],
- "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.
- "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.
- "domain": "A String", # The name of the domain (e.g., mydomain.com).
- "kind": "A String", # This is always sql#activeDirectoryConfig.
- },
- },
- "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
- "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
- "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
- "canDefer": True or False,
- },
- "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
- "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.
- "kind": "A String", # This is always *sql#replicaConfiguration*.
- "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.
- "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
- "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
- "username": "A String", # The username for the replication connection.
- "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
- "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
- "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.
- "password": "A String", # The password for the replication connection.
- "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
- "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.
- "kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.
- "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
- },
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.
+ "rootPassword": "A String", # Initial root password. Use only on creation.
+ "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
+ "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ "kind": "A String", # This is always *sql#diskEncryptionConfiguration*.
},
"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance has been stopped by owner. It is not currently running, but it's ready to be restarted. *SUSPENDED*: The instance is not available, for example due to problems with billing. for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.
+ "serverCaCert": { # SslCerts Resource # SSL configuration.
+ "cert": "A String", # PEM representation.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "instance": "A String", # Name of the database instance.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ "kind": "A String", # This is always *sql#sslCert*.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "selfLink": "A String", # The URI of this resource.
+ "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
+ },
+ "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "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.
"diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. Applies only to Second Generation instances.
"kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
"kind": "A String", # This is always *sql#diskEncryptionStatus*.
},
- "replicaNames": [ # The replicas of the instance.
- "A String",
- ],
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"kind": "A String", # This is always *sql#instance*.
- "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "satisfiesPzs": True or False, # The status indicating if instance satisfies physical zone separation. Reserved for future use.
+ "settings": { # Database instance settings. # The user settings.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
+ "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.
+ "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.
+ "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: *192.168.100.0/24*).
+ { # An entry for an Access Control list.
+ "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "kind": "A String", # This is always *sql#aclEntry*.
+ "value": "A String", # The allowlisted value for the access control list.
+ "name": "A String", # Optional. A label to identify this entry.
+ },
+ ],
+ "requireSsl": True or False, # Whether SSL connections over IP are enforced or not.
+ "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.
+ },
+ "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.
+ "databaseFlags": [ # The database flags passed to the instance at startup.
+ { # Database flags for Cloud SQL instances.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
+ "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.
+ },
+ ],
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
+ "A String",
+ ],
+ "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.
+ "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.
+ "a_key": "A String",
+ },
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. 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.
+ "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
+ "kind": "A String", # This is always *sql#locationPreference*.
+ "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.
+ "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
+ },
+ "dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
+ "tier": "A String", # The tier (or machine type) for this instance, for example *db-n1-standard-1* (MySQL instances) or *db-custom-1-3840* (PostgreSQL instances).
+ "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
+ "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
+ "kind": "A String", # This is always *sql#backupConfiguration*.
+ "location": "A String", # Location of the backup
+ "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.
+ "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.
+ "retentionUnit": "A String", # The unit that 'retained_backups' represents.
+ "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.
+ },
+ "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
+ "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.
+ "replicationLogArchivingEnabled": True or False, # Reserved for future use.
+ "enabled": True or False, # Whether this configuration is enabled.
+ },
+ "denyMaintenancePeriods": [ # Deny maintenance periods
+ { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.
+ "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 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
+ "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
+ "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
+ },
+ ],
+ "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.
+ "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.
+ "collation": "A String", # The name of server Instance collation.
+ "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.
+ "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.
+ "domain": "A String", # The name of the domain (e.g., mydomain.com).
+ "kind": "A String", # This is always sql#activeDirectoryConfig.
+ },
+ "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.
+ "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.
+ "hour": 42, # hour of day - 0 to 23.
+ "updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.
+ "day": 42, # day of week (1-7), starting on Monday.
+ "kind": "A String", # This is always *sql#maintenanceWindow*.
+ },
+ "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.
+ "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.
+ "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.
+ "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.
+ "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.
+ },
+ "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.
+ "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.
+ "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.
+ "kind": "A String", # This is always *sql#settings*.
+ },
+ "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.
+ "selfLink": "A String", # The URI of this resource.
"ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
+ "instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
+ "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.
+ "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.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "password": "A String", # The password for the replication connection.
+ "username": "A String", # The username for the replication connection.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "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.
+ "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.
+ },
+ "kind": "A String", # This is always *sql#replicaConfiguration*.
+ },
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
+ "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.
+ "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 for details.
}</pre>
</div>
@@ -914,17 +944,6 @@
{ # Database instance import request.
"importContext": { # Database instance import context. # Contains details about the import operation.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -932,6 +951,17 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
}
@@ -943,10 +973,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -954,49 +985,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -1004,9 +995,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -1020,172 +1054,178 @@
The object takes the form of:
{ # A Cloud SQL instance resource. Next field: 36
- "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
- "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.
- "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.
- "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.
- "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
- "password": "A String", # The password for connecting to on-premises instance.
- "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
- "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
- "kind": "A String", # This is always *sql#onPremisesConfiguration*.
- "hostPort": "A String", # The host and port of the on-premises instance in host:port format
- "username": "A String", # The username for connecting to on-premises instance.
- "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
- "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
+ "canDefer": True or False,
+ "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
+ "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
},
- "instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.
- "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
- "kind": "A String", # This is always *sql#diskEncryptionConfiguration*.
- "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
- },
- "rootPassword": "A String", # Initial root password. Use only on creation.
+ "backendType": "A String", # *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.
"failoverReplica": { # The name and status of the failover replica. This property is applicable only to Second Generation instances.
"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.
"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. This property is applicable only to Second Generation instances.
},
- "serverCaCert": { # SslCerts Resource # SSL configuration.
- "kind": "A String", # This is always *sql#sslCert*.
- "instance": "A String", # Name of the database instance.
- "cert": "A String", # PEM representation.
- "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
- "sha1Fingerprint": "A String", # Sha1 Fingerprint.
- "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
- "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
- "selfLink": "A String", # The URI of this resource.
- "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- },
"databaseVersion": "A String", # The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11* or *POSTGRES_12* (default). SQL Server instances: *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.
- "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.
"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
"A String",
],
- "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
- "selfLink": "A String", # The URI of this resource.
+ "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.
+ "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "username": "A String", # The username for connecting to on-premises instance.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "kind": "A String", # This is always *sql#onPremisesConfiguration*.
+ "password": "A String", # The password for connecting to on-premises instance.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
+ },
"ipAddresses": [ # The assigned IP addresses for the instance.
{ # Database instance IP Mapping.
"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.
- "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.
"ipAddress": "A String", # The IP address assigned.
+ "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.
},
],
- "satisfiesPzs": True or False, # The status indicating if instance satisfies physical zone separation. Reserved for future use.
- "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.
- "backendType": "A String", # *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.
- "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 for details.
- "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance has been stopped by owner. It is not currently running, but it's ready to be restarted. *SUSPENDED*: The instance is not available, for example due to problems with billing. for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.
- "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
- "settings": { # Database instance settings. # The user settings.
- "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.
- "kind": "A String", # This is always *sql#settings*.
- "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.
- "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.
- "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.
- "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.
- "dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
- "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
- "enabled": True or False, # Whether this configuration is enabled.
- "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.
- "retentionUnit": "A String", # The unit that 'retained_backups' represents.
- "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.
- },
- "kind": "A String", # This is always *sql#backupConfiguration*.
- "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.
- "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
- "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.
- "replicationLogArchivingEnabled": True or False, # Reserved for future use.
- "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
- "location": "A String", # Location of the backup
- },
- "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. 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.
- "kind": "A String", # This is always *sql#locationPreference*.
- "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
- "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
- "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.
- },
- "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.
- "tier": "A String", # The tier (or machine type) for this instance, for example *db-n1-standard-1* (MySQL instances) or *db-custom-1-3840* (PostgreSQL instances).
- "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.
- "collation": "A String", # The name of server Instance collation.
- "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.
- "day": 42, # day of week (1-7), starting on Monday.
- "kind": "A String", # This is always *sql#maintenanceWindow*.
- "hour": 42, # hour of day - 0 to 23.
- "updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.
- },
- "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.
- "a_key": "A String",
- },
- "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.
- "databaseFlags": [ # The database flags passed to the instance at startup.
- { # Database flags for Cloud SQL instances.
- "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.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
- },
- ],
- "denyMaintenancePeriods": [ # Deny maintenance periods
- { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.
- "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 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
- "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
- "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
- },
- ],
- "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
- "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.
- "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.
- "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: *192.168.100.0/24*).
- { # An entry for an Access Control list.
- "kind": "A String", # This is always *sql#aclEntry*.
- "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "name": "A String", # Optional. A label to identify this entry.
- "value": "A String", # The allowlisted value for the access control list.
- },
- ],
- "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.
- "requireSsl": True or False, # Whether SSL connections over IP are enforced or not.
- },
- "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
- "A String",
- ],
- "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.
- "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.
- "domain": "A String", # The name of the domain (e.g., mydomain.com).
- "kind": "A String", # This is always sql#activeDirectoryConfig.
- },
- },
- "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
- "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
- "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
- "canDefer": True or False,
- },
- "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
- "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.
- "kind": "A String", # This is always *sql#replicaConfiguration*.
- "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.
- "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
- "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
- "username": "A String", # The username for the replication connection.
- "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
- "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
- "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.
- "password": "A String", # The password for the replication connection.
- "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
- "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.
- "kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.
- "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
- },
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.
+ "rootPassword": "A String", # Initial root password. Use only on creation.
+ "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
+ "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ "kind": "A String", # This is always *sql#diskEncryptionConfiguration*.
},
"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance has been stopped by owner. It is not currently running, but it's ready to be restarted. *SUSPENDED*: The instance is not available, for example due to problems with billing. for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.
+ "serverCaCert": { # SslCerts Resource # SSL configuration.
+ "cert": "A String", # PEM representation.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "instance": "A String", # Name of the database instance.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ "kind": "A String", # This is always *sql#sslCert*.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "selfLink": "A String", # The URI of this resource.
+ "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
+ },
+ "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "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.
"diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. Applies only to Second Generation instances.
"kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
"kind": "A String", # This is always *sql#diskEncryptionStatus*.
},
- "replicaNames": [ # The replicas of the instance.
- "A String",
- ],
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"kind": "A String", # This is always *sql#instance*.
- "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "satisfiesPzs": True or False, # The status indicating if instance satisfies physical zone separation. Reserved for future use.
+ "settings": { # Database instance settings. # The user settings.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
+ "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.
+ "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.
+ "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: *192.168.100.0/24*).
+ { # An entry for an Access Control list.
+ "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "kind": "A String", # This is always *sql#aclEntry*.
+ "value": "A String", # The allowlisted value for the access control list.
+ "name": "A String", # Optional. A label to identify this entry.
+ },
+ ],
+ "requireSsl": True or False, # Whether SSL connections over IP are enforced or not.
+ "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.
+ },
+ "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.
+ "databaseFlags": [ # The database flags passed to the instance at startup.
+ { # Database flags for Cloud SQL instances.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
+ "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.
+ },
+ ],
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
+ "A String",
+ ],
+ "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.
+ "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.
+ "a_key": "A String",
+ },
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. 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.
+ "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
+ "kind": "A String", # This is always *sql#locationPreference*.
+ "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.
+ "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
+ },
+ "dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
+ "tier": "A String", # The tier (or machine type) for this instance, for example *db-n1-standard-1* (MySQL instances) or *db-custom-1-3840* (PostgreSQL instances).
+ "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
+ "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
+ "kind": "A String", # This is always *sql#backupConfiguration*.
+ "location": "A String", # Location of the backup
+ "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.
+ "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.
+ "retentionUnit": "A String", # The unit that 'retained_backups' represents.
+ "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.
+ },
+ "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
+ "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.
+ "replicationLogArchivingEnabled": True or False, # Reserved for future use.
+ "enabled": True or False, # Whether this configuration is enabled.
+ },
+ "denyMaintenancePeriods": [ # Deny maintenance periods
+ { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.
+ "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 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
+ "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
+ "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
+ },
+ ],
+ "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.
+ "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.
+ "collation": "A String", # The name of server Instance collation.
+ "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.
+ "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.
+ "domain": "A String", # The name of the domain (e.g., mydomain.com).
+ "kind": "A String", # This is always sql#activeDirectoryConfig.
+ },
+ "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.
+ "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.
+ "hour": 42, # hour of day - 0 to 23.
+ "updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.
+ "day": 42, # day of week (1-7), starting on Monday.
+ "kind": "A String", # This is always *sql#maintenanceWindow*.
+ },
+ "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.
+ "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.
+ "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.
+ "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.
+ "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.
+ },
+ "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.
+ "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.
+ "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.
+ "kind": "A String", # This is always *sql#settings*.
+ },
+ "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.
+ "selfLink": "A String", # The URI of this resource.
"ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
+ "instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
+ "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.
+ "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.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "password": "A String", # The password for the replication connection.
+ "username": "A String", # The username for the replication connection.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "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.
+ "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.
+ },
+ "kind": "A String", # This is always *sql#replicaConfiguration*.
+ },
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
+ "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.
+ "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 for details.
}
x__xgafv: string, V1 error format.
@@ -1196,10 +1236,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -1207,49 +1248,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -1257,21 +1258,64 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, filter=None, pageToken=None, maxResults=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(project, maxResults=None, filter=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists instances under a given project.
Args:
project: string, Project ID of the project for which to list Cloud SQL instances. (required)
+ maxResults: integer, The maximum number of results to return per response.
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.
pageToken: string, A previously-returned page token representing part of the larger set of results to view.
- maxResults: integer, The maximum number of results to return per response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1281,184 +1325,190 @@
An object of the form:
{ # Database instances list response.
- "kind": "A String", # This is always *sql#instancesList*.
"warnings": [ # List of warnings that occurred while handling the request.
{ # An Admin API warning message.
"message": "A String", # The warning message.
"code": "A String", # Code to uniquely identify the warning type.
},
],
+ "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.
+ "kind": "A String", # This is always *sql#instancesList*.
"items": [ # List of database instance resources.
{ # A Cloud SQL instance resource. Next field: 36
- "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
- "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.
- "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.
- "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.
- "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
- "password": "A String", # The password for connecting to on-premises instance.
- "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
- "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
- "kind": "A String", # This is always *sql#onPremisesConfiguration*.
- "hostPort": "A String", # The host and port of the on-premises instance in host:port format
- "username": "A String", # The username for connecting to on-premises instance.
- "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
- "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
+ "canDefer": True or False,
+ "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
+ "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
},
- "instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.
- "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
- "kind": "A String", # This is always *sql#diskEncryptionConfiguration*.
- "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
- },
- "rootPassword": "A String", # Initial root password. Use only on creation.
+ "backendType": "A String", # *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.
"failoverReplica": { # The name and status of the failover replica. This property is applicable only to Second Generation instances.
"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.
"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. This property is applicable only to Second Generation instances.
},
- "serverCaCert": { # SslCerts Resource # SSL configuration.
- "kind": "A String", # This is always *sql#sslCert*.
- "instance": "A String", # Name of the database instance.
- "cert": "A String", # PEM representation.
- "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
- "sha1Fingerprint": "A String", # Sha1 Fingerprint.
- "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
- "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
- "selfLink": "A String", # The URI of this resource.
- "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- },
"databaseVersion": "A String", # The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11* or *POSTGRES_12* (default). SQL Server instances: *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.
- "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.
"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
"A String",
],
- "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
- "selfLink": "A String", # The URI of this resource.
+ "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.
+ "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "username": "A String", # The username for connecting to on-premises instance.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "kind": "A String", # This is always *sql#onPremisesConfiguration*.
+ "password": "A String", # The password for connecting to on-premises instance.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
+ },
"ipAddresses": [ # The assigned IP addresses for the instance.
{ # Database instance IP Mapping.
"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.
- "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.
"ipAddress": "A String", # The IP address assigned.
+ "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.
},
],
- "satisfiesPzs": True or False, # The status indicating if instance satisfies physical zone separation. Reserved for future use.
- "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.
- "backendType": "A String", # *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.
- "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 for details.
- "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance has been stopped by owner. It is not currently running, but it's ready to be restarted. *SUSPENDED*: The instance is not available, for example due to problems with billing. for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.
- "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
- "settings": { # Database instance settings. # The user settings.
- "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.
- "kind": "A String", # This is always *sql#settings*.
- "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.
- "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.
- "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.
- "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.
- "dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
- "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
- "enabled": True or False, # Whether this configuration is enabled.
- "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.
- "retentionUnit": "A String", # The unit that 'retained_backups' represents.
- "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.
- },
- "kind": "A String", # This is always *sql#backupConfiguration*.
- "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.
- "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
- "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.
- "replicationLogArchivingEnabled": True or False, # Reserved for future use.
- "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
- "location": "A String", # Location of the backup
- },
- "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. 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.
- "kind": "A String", # This is always *sql#locationPreference*.
- "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
- "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
- "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.
- },
- "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.
- "tier": "A String", # The tier (or machine type) for this instance, for example *db-n1-standard-1* (MySQL instances) or *db-custom-1-3840* (PostgreSQL instances).
- "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.
- "collation": "A String", # The name of server Instance collation.
- "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.
- "day": 42, # day of week (1-7), starting on Monday.
- "kind": "A String", # This is always *sql#maintenanceWindow*.
- "hour": 42, # hour of day - 0 to 23.
- "updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.
- },
- "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.
- "a_key": "A String",
- },
- "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.
- "databaseFlags": [ # The database flags passed to the instance at startup.
- { # Database flags for Cloud SQL instances.
- "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.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
- },
- ],
- "denyMaintenancePeriods": [ # Deny maintenance periods
- { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.
- "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 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
- "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
- "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
- },
- ],
- "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
- "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.
- "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.
- "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: *192.168.100.0/24*).
- { # An entry for an Access Control list.
- "kind": "A String", # This is always *sql#aclEntry*.
- "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "name": "A String", # Optional. A label to identify this entry.
- "value": "A String", # The allowlisted value for the access control list.
- },
- ],
- "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.
- "requireSsl": True or False, # Whether SSL connections over IP are enforced or not.
- },
- "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
- "A String",
- ],
- "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.
- "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.
- "domain": "A String", # The name of the domain (e.g., mydomain.com).
- "kind": "A String", # This is always sql#activeDirectoryConfig.
- },
- },
- "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
- "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
- "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
- "canDefer": True or False,
- },
- "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
- "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.
- "kind": "A String", # This is always *sql#replicaConfiguration*.
- "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.
- "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
- "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
- "username": "A String", # The username for the replication connection.
- "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
- "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
- "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.
- "password": "A String", # The password for the replication connection.
- "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
- "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.
- "kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.
- "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
- },
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.
+ "rootPassword": "A String", # Initial root password. Use only on creation.
+ "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
+ "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ "kind": "A String", # This is always *sql#diskEncryptionConfiguration*.
},
"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance has been stopped by owner. It is not currently running, but it's ready to be restarted. *SUSPENDED*: The instance is not available, for example due to problems with billing. for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.
+ "serverCaCert": { # SslCerts Resource # SSL configuration.
+ "cert": "A String", # PEM representation.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "instance": "A String", # Name of the database instance.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ "kind": "A String", # This is always *sql#sslCert*.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "selfLink": "A String", # The URI of this resource.
+ "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
+ },
+ "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "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.
"diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. Applies only to Second Generation instances.
"kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
"kind": "A String", # This is always *sql#diskEncryptionStatus*.
},
- "replicaNames": [ # The replicas of the instance.
- "A String",
- ],
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"kind": "A String", # This is always *sql#instance*.
- "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "satisfiesPzs": True or False, # The status indicating if instance satisfies physical zone separation. Reserved for future use.
+ "settings": { # Database instance settings. # The user settings.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
+ "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.
+ "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.
+ "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: *192.168.100.0/24*).
+ { # An entry for an Access Control list.
+ "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "kind": "A String", # This is always *sql#aclEntry*.
+ "value": "A String", # The allowlisted value for the access control list.
+ "name": "A String", # Optional. A label to identify this entry.
+ },
+ ],
+ "requireSsl": True or False, # Whether SSL connections over IP are enforced or not.
+ "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.
+ },
+ "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.
+ "databaseFlags": [ # The database flags passed to the instance at startup.
+ { # Database flags for Cloud SQL instances.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
+ "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.
+ },
+ ],
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
+ "A String",
+ ],
+ "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.
+ "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.
+ "a_key": "A String",
+ },
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. 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.
+ "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
+ "kind": "A String", # This is always *sql#locationPreference*.
+ "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.
+ "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
+ },
+ "dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
+ "tier": "A String", # The tier (or machine type) for this instance, for example *db-n1-standard-1* (MySQL instances) or *db-custom-1-3840* (PostgreSQL instances).
+ "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
+ "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
+ "kind": "A String", # This is always *sql#backupConfiguration*.
+ "location": "A String", # Location of the backup
+ "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.
+ "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.
+ "retentionUnit": "A String", # The unit that 'retained_backups' represents.
+ "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.
+ },
+ "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
+ "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.
+ "replicationLogArchivingEnabled": True or False, # Reserved for future use.
+ "enabled": True or False, # Whether this configuration is enabled.
+ },
+ "denyMaintenancePeriods": [ # Deny maintenance periods
+ { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.
+ "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 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
+ "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
+ "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
+ },
+ ],
+ "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.
+ "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.
+ "collation": "A String", # The name of server Instance collation.
+ "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.
+ "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.
+ "domain": "A String", # The name of the domain (e.g., mydomain.com).
+ "kind": "A String", # This is always sql#activeDirectoryConfig.
+ },
+ "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.
+ "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.
+ "hour": 42, # hour of day - 0 to 23.
+ "updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.
+ "day": 42, # day of week (1-7), starting on Monday.
+ "kind": "A String", # This is always *sql#maintenanceWindow*.
+ },
+ "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.
+ "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.
+ "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.
+ "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.
+ "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.
+ },
+ "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.
+ "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.
+ "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.
+ "kind": "A String", # This is always *sql#settings*.
+ },
+ "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.
+ "selfLink": "A String", # The URI of this resource.
"ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
+ "instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
+ "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.
+ "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.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "password": "A String", # The password for the replication connection.
+ "username": "A String", # The username for the replication connection.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "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.
+ "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.
+ },
+ "kind": "A String", # This is always *sql#replicaConfiguration*.
+ },
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
+ "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.
+ "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 for details.
},
],
- "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.
}</pre>
</div>
@@ -1478,19 +1528,19 @@
An object of the form:
{ # Instances ListServerCas response.
- "activeVersion": "A String",
"kind": "A String", # This is always *sql#instancesListServerCas*.
+ "activeVersion": "A String",
"certs": [ # List of server CA certificates for the instance.
{ # SslCerts Resource
- "kind": "A String", # This is always *sql#sslCert*.
- "instance": "A String", # Name of the database instance.
"cert": "A String", # PEM representation.
- "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
- "sha1Fingerprint": "A String", # Sha1 Fingerprint.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
- "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
+ "instance": "A String", # Name of the database instance.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ "kind": "A String", # This is always *sql#sslCert*.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
"selfLink": "A String", # The URI of this resource.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
},
],
}</pre>
@@ -1521,172 +1571,178 @@
The object takes the form of:
{ # A Cloud SQL instance resource. Next field: 36
- "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
- "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.
- "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.
- "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.
- "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
- "password": "A String", # The password for connecting to on-premises instance.
- "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
- "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
- "kind": "A String", # This is always *sql#onPremisesConfiguration*.
- "hostPort": "A String", # The host and port of the on-premises instance in host:port format
- "username": "A String", # The username for connecting to on-premises instance.
- "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
- "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
+ "canDefer": True or False,
+ "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
+ "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
},
- "instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.
- "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
- "kind": "A String", # This is always *sql#diskEncryptionConfiguration*.
- "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
- },
- "rootPassword": "A String", # Initial root password. Use only on creation.
+ "backendType": "A String", # *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.
"failoverReplica": { # The name and status of the failover replica. This property is applicable only to Second Generation instances.
"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.
"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. This property is applicable only to Second Generation instances.
},
- "serverCaCert": { # SslCerts Resource # SSL configuration.
- "kind": "A String", # This is always *sql#sslCert*.
- "instance": "A String", # Name of the database instance.
- "cert": "A String", # PEM representation.
- "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
- "sha1Fingerprint": "A String", # Sha1 Fingerprint.
- "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
- "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
- "selfLink": "A String", # The URI of this resource.
- "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- },
"databaseVersion": "A String", # The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11* or *POSTGRES_12* (default). SQL Server instances: *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.
- "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.
"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
"A String",
],
- "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
- "selfLink": "A String", # The URI of this resource.
+ "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.
+ "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "username": "A String", # The username for connecting to on-premises instance.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "kind": "A String", # This is always *sql#onPremisesConfiguration*.
+ "password": "A String", # The password for connecting to on-premises instance.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
+ },
"ipAddresses": [ # The assigned IP addresses for the instance.
{ # Database instance IP Mapping.
"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.
- "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.
"ipAddress": "A String", # The IP address assigned.
+ "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.
},
],
- "satisfiesPzs": True or False, # The status indicating if instance satisfies physical zone separation. Reserved for future use.
- "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.
- "backendType": "A String", # *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.
- "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 for details.
- "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance has been stopped by owner. It is not currently running, but it's ready to be restarted. *SUSPENDED*: The instance is not available, for example due to problems with billing. for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.
- "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
- "settings": { # Database instance settings. # The user settings.
- "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.
- "kind": "A String", # This is always *sql#settings*.
- "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.
- "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.
- "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.
- "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.
- "dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
- "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
- "enabled": True or False, # Whether this configuration is enabled.
- "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.
- "retentionUnit": "A String", # The unit that 'retained_backups' represents.
- "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.
- },
- "kind": "A String", # This is always *sql#backupConfiguration*.
- "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.
- "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
- "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.
- "replicationLogArchivingEnabled": True or False, # Reserved for future use.
- "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
- "location": "A String", # Location of the backup
- },
- "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. 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.
- "kind": "A String", # This is always *sql#locationPreference*.
- "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
- "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
- "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.
- },
- "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.
- "tier": "A String", # The tier (or machine type) for this instance, for example *db-n1-standard-1* (MySQL instances) or *db-custom-1-3840* (PostgreSQL instances).
- "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.
- "collation": "A String", # The name of server Instance collation.
- "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.
- "day": 42, # day of week (1-7), starting on Monday.
- "kind": "A String", # This is always *sql#maintenanceWindow*.
- "hour": 42, # hour of day - 0 to 23.
- "updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.
- },
- "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.
- "a_key": "A String",
- },
- "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.
- "databaseFlags": [ # The database flags passed to the instance at startup.
- { # Database flags for Cloud SQL instances.
- "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.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
- },
- ],
- "denyMaintenancePeriods": [ # Deny maintenance periods
- { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.
- "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 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
- "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
- "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
- },
- ],
- "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
- "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.
- "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.
- "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: *192.168.100.0/24*).
- { # An entry for an Access Control list.
- "kind": "A String", # This is always *sql#aclEntry*.
- "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "name": "A String", # Optional. A label to identify this entry.
- "value": "A String", # The allowlisted value for the access control list.
- },
- ],
- "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.
- "requireSsl": True or False, # Whether SSL connections over IP are enforced or not.
- },
- "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
- "A String",
- ],
- "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.
- "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.
- "domain": "A String", # The name of the domain (e.g., mydomain.com).
- "kind": "A String", # This is always sql#activeDirectoryConfig.
- },
- },
- "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
- "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
- "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
- "canDefer": True or False,
- },
- "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
- "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.
- "kind": "A String", # This is always *sql#replicaConfiguration*.
- "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.
- "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
- "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
- "username": "A String", # The username for the replication connection.
- "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
- "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
- "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.
- "password": "A String", # The password for the replication connection.
- "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
- "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.
- "kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.
- "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
- },
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.
+ "rootPassword": "A String", # Initial root password. Use only on creation.
+ "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
+ "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ "kind": "A String", # This is always *sql#diskEncryptionConfiguration*.
},
"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance has been stopped by owner. It is not currently running, but it's ready to be restarted. *SUSPENDED*: The instance is not available, for example due to problems with billing. for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.
+ "serverCaCert": { # SslCerts Resource # SSL configuration.
+ "cert": "A String", # PEM representation.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "instance": "A String", # Name of the database instance.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ "kind": "A String", # This is always *sql#sslCert*.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "selfLink": "A String", # The URI of this resource.
+ "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
+ },
+ "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "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.
"diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. Applies only to Second Generation instances.
"kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
"kind": "A String", # This is always *sql#diskEncryptionStatus*.
},
- "replicaNames": [ # The replicas of the instance.
- "A String",
- ],
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"kind": "A String", # This is always *sql#instance*.
- "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "satisfiesPzs": True or False, # The status indicating if instance satisfies physical zone separation. Reserved for future use.
+ "settings": { # Database instance settings. # The user settings.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
+ "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.
+ "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.
+ "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: *192.168.100.0/24*).
+ { # An entry for an Access Control list.
+ "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "kind": "A String", # This is always *sql#aclEntry*.
+ "value": "A String", # The allowlisted value for the access control list.
+ "name": "A String", # Optional. A label to identify this entry.
+ },
+ ],
+ "requireSsl": True or False, # Whether SSL connections over IP are enforced or not.
+ "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.
+ },
+ "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.
+ "databaseFlags": [ # The database flags passed to the instance at startup.
+ { # Database flags for Cloud SQL instances.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
+ "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.
+ },
+ ],
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
+ "A String",
+ ],
+ "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.
+ "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.
+ "a_key": "A String",
+ },
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. 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.
+ "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
+ "kind": "A String", # This is always *sql#locationPreference*.
+ "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.
+ "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
+ },
+ "dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
+ "tier": "A String", # The tier (or machine type) for this instance, for example *db-n1-standard-1* (MySQL instances) or *db-custom-1-3840* (PostgreSQL instances).
+ "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
+ "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
+ "kind": "A String", # This is always *sql#backupConfiguration*.
+ "location": "A String", # Location of the backup
+ "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.
+ "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.
+ "retentionUnit": "A String", # The unit that 'retained_backups' represents.
+ "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.
+ },
+ "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
+ "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.
+ "replicationLogArchivingEnabled": True or False, # Reserved for future use.
+ "enabled": True or False, # Whether this configuration is enabled.
+ },
+ "denyMaintenancePeriods": [ # Deny maintenance periods
+ { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.
+ "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 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
+ "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
+ "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
+ },
+ ],
+ "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.
+ "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.
+ "collation": "A String", # The name of server Instance collation.
+ "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.
+ "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.
+ "domain": "A String", # The name of the domain (e.g., mydomain.com).
+ "kind": "A String", # This is always sql#activeDirectoryConfig.
+ },
+ "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.
+ "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.
+ "hour": 42, # hour of day - 0 to 23.
+ "updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.
+ "day": 42, # day of week (1-7), starting on Monday.
+ "kind": "A String", # This is always *sql#maintenanceWindow*.
+ },
+ "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.
+ "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.
+ "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.
+ "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.
+ "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.
+ },
+ "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.
+ "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.
+ "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.
+ "kind": "A String", # This is always *sql#settings*.
+ },
+ "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.
+ "selfLink": "A String", # The URI of this resource.
"ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
+ "instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
+ "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.
+ "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.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "password": "A String", # The password for the replication connection.
+ "username": "A String", # The username for the replication connection.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "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.
+ "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.
+ },
+ "kind": "A String", # This is always *sql#replicaConfiguration*.
+ },
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
+ "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.
+ "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 for details.
}
x__xgafv: string, V1 error format.
@@ -1697,10 +1753,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -1708,49 +1765,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -1758,9 +1775,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -1779,10 +1839,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -1790,49 +1851,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -1840,9 +1861,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -1861,10 +1925,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -1872,49 +1937,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -1922,9 +1947,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -1943,10 +2011,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -1954,49 +2023,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -2004,9 +2033,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -2037,10 +2109,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -2048,49 +2121,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -2098,9 +2131,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -2116,8 +2192,8 @@
{ # Rotate Server CA request.
"rotateServerCaContext": { # Instance rotate server CA context. # Contains details about the rotate server CA operation.
- "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.
"kind": "A String", # This is always *sql#rotateServerCaContext*.
+ "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.
},
}
@@ -2129,10 +2205,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -2140,49 +2217,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -2190,9 +2227,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -2211,10 +2291,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -2222,49 +2303,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -2272,9 +2313,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -2293,10 +2377,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -2304,49 +2389,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -2354,9 +2399,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -2385,10 +2473,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -2396,49 +2485,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -2446,9 +2495,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>
@@ -2463,172 +2555,178 @@
The object takes the form of:
{ # A Cloud SQL instance resource. Next field: 36
- "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
- "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.
- "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.
- "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.
- "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
- "password": "A String", # The password for connecting to on-premises instance.
- "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
- "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
- "kind": "A String", # This is always *sql#onPremisesConfiguration*.
- "hostPort": "A String", # The host and port of the on-premises instance in host:port format
- "username": "A String", # The username for connecting to on-premises instance.
- "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
- "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
+ "canDefer": True or False,
+ "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
+ "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
},
- "instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.
- "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
- "kind": "A String", # This is always *sql#diskEncryptionConfiguration*.
- "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
- },
- "rootPassword": "A String", # Initial root password. Use only on creation.
+ "backendType": "A String", # *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.
"failoverReplica": { # The name and status of the failover replica. This property is applicable only to Second Generation instances.
"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.
"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. This property is applicable only to Second Generation instances.
},
- "serverCaCert": { # SslCerts Resource # SSL configuration.
- "kind": "A String", # This is always *sql#sslCert*.
- "instance": "A String", # Name of the database instance.
- "cert": "A String", # PEM representation.
- "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
- "sha1Fingerprint": "A String", # Sha1 Fingerprint.
- "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
- "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
- "selfLink": "A String", # The URI of this resource.
- "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- },
"databaseVersion": "A String", # The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11* or *POSTGRES_12* (default). SQL Server instances: *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.
- "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.
"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
"A String",
],
- "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
- "selfLink": "A String", # The URI of this resource.
+ "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.
+ "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "username": "A String", # The username for connecting to on-premises instance.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "kind": "A String", # This is always *sql#onPremisesConfiguration*.
+ "password": "A String", # The password for connecting to on-premises instance.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
+ },
"ipAddresses": [ # The assigned IP addresses for the instance.
{ # Database instance IP Mapping.
"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.
- "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.
"ipAddress": "A String", # The IP address assigned.
+ "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired.
},
],
- "satisfiesPzs": True or False, # The status indicating if instance satisfies physical zone separation. Reserved for future use.
- "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.
- "backendType": "A String", # *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.
- "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 for details.
- "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance has been stopped by owner. It is not currently running, but it's ready to be restarted. *SUSPENDED*: The instance is not available, for example due to problems with billing. for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.
- "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
- "settings": { # Database instance settings. # The user settings.
- "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.
- "kind": "A String", # This is always *sql#settings*.
- "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.
- "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.
- "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.
- "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.
- "dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
- "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
- "enabled": True or False, # Whether this configuration is enabled.
- "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.
- "retentionUnit": "A String", # The unit that 'retained_backups' represents.
- "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.
- },
- "kind": "A String", # This is always *sql#backupConfiguration*.
- "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.
- "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
- "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.
- "replicationLogArchivingEnabled": True or False, # Reserved for future use.
- "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
- "location": "A String", # Location of the backup
- },
- "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. 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.
- "kind": "A String", # This is always *sql#locationPreference*.
- "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
- "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
- "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.
- },
- "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.
- "tier": "A String", # The tier (or machine type) for this instance, for example *db-n1-standard-1* (MySQL instances) or *db-custom-1-3840* (PostgreSQL instances).
- "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.
- "collation": "A String", # The name of server Instance collation.
- "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.
- "day": 42, # day of week (1-7), starting on Monday.
- "kind": "A String", # This is always *sql#maintenanceWindow*.
- "hour": 42, # hour of day - 0 to 23.
- "updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.
- },
- "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.
- "a_key": "A String",
- },
- "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.
- "databaseFlags": [ # The database flags passed to the instance at startup.
- { # Database flags for Cloud SQL instances.
- "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.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
- },
- ],
- "denyMaintenancePeriods": [ # Deny maintenance periods
- { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.
- "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 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
- "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
- "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
- },
- ],
- "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
- "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.
- "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.
- "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: *192.168.100.0/24*).
- { # An entry for an Access Control list.
- "kind": "A String", # This is always *sql#aclEntry*.
- "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "name": "A String", # Optional. A label to identify this entry.
- "value": "A String", # The allowlisted value for the access control list.
- },
- ],
- "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.
- "requireSsl": True or False, # Whether SSL connections over IP are enforced or not.
- },
- "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
- "A String",
- ],
- "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.
- "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.
- "domain": "A String", # The name of the domain (e.g., mydomain.com).
- "kind": "A String", # This is always sql#activeDirectoryConfig.
- },
- },
- "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
- "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
- "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
- "canDefer": True or False,
- },
- "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
- "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.
- "kind": "A String", # This is always *sql#replicaConfiguration*.
- "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.
- "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
- "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
- "username": "A String", # The username for the replication connection.
- "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
- "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
- "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.
- "password": "A String", # The password for the replication connection.
- "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
- "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.
- "kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.
- "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
- },
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.
+ "rootPassword": "A String", # Initial root password. Use only on creation.
+ "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
+ "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ "kind": "A String", # This is always *sql#diskEncryptionConfiguration*.
},
"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance has been stopped by owner. It is not currently running, but it's ready to be restarted. *SUSPENDED*: The instance is not available, for example due to problems with billing. for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.
+ "serverCaCert": { # SslCerts Resource # SSL configuration.
+ "cert": "A String", # PEM representation.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "instance": "A String", # Name of the database instance.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ "kind": "A String", # This is always *sql#sslCert*.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "selfLink": "A String", # The URI of this resource.
+ "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
+ },
+ "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "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.
"diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. Applies only to Second Generation instances.
"kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
"kind": "A String", # This is always *sql#diskEncryptionStatus*.
},
- "replicaNames": [ # The replicas of the instance.
- "A String",
- ],
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"kind": "A String", # This is always *sql#instance*.
- "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "satisfiesPzs": True or False, # The status indicating if instance satisfies physical zone separation. Reserved for future use.
+ "settings": { # Database instance settings. # The user settings.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
+ "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.
+ "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.
+ "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: *192.168.100.0/24*).
+ { # An entry for an Access Control list.
+ "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "kind": "A String", # This is always *sql#aclEntry*.
+ "value": "A String", # The allowlisted value for the access control list.
+ "name": "A String", # Optional. A label to identify this entry.
+ },
+ ],
+ "requireSsl": True or False, # Whether SSL connections over IP are enforced or not.
+ "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.
+ },
+ "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.
+ "databaseFlags": [ # The database flags passed to the instance at startup.
+ { # Database flags for Cloud SQL instances.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
+ "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.
+ },
+ ],
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
+ "A String",
+ ],
+ "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.
+ "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.
+ "a_key": "A String",
+ },
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. 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.
+ "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
+ "kind": "A String", # This is always *sql#locationPreference*.
+ "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.
+ "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
+ },
+ "dataDiskType": "A String", # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
+ "tier": "A String", # The tier (or machine type) for this instance, for example *db-n1-standard-1* (MySQL instances) or *db-custom-1-3840* (PostgreSQL instances).
+ "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
+ "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
+ "kind": "A String", # This is always *sql#backupConfiguration*.
+ "location": "A String", # Location of the backup
+ "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.
+ "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.
+ "retentionUnit": "A String", # The unit that 'retained_backups' represents.
+ "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.
+ },
+ "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
+ "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*.
+ "replicationLogArchivingEnabled": True or False, # Reserved for future use.
+ "enabled": True or False, # Whether this configuration is enabled.
+ },
+ "denyMaintenancePeriods": [ # Deny maintenance periods
+ { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.
+ "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 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
+ "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
+ "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
+ },
+ ],
+ "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.
+ "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.
+ "collation": "A String", # The name of server Instance collation.
+ "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.
+ "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.
+ "domain": "A String", # The name of the domain (e.g., mydomain.com).
+ "kind": "A String", # This is always sql#activeDirectoryConfig.
+ },
+ "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.
+ "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.
+ "hour": 42, # hour of day - 0 to 23.
+ "updateTrack": "A String", # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more.
+ "day": 42, # day of week (1-7), starting on Monday.
+ "kind": "A String", # This is always *sql#maintenanceWindow*.
+ },
+ "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.
+ "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.
+ "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.
+ "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.
+ "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.
+ },
+ "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.
+ "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.
+ "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.
+ "kind": "A String", # This is always *sql#settings*.
+ },
+ "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.
+ "selfLink": "A String", # The URI of this resource.
"ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
+ "instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
+ "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.
+ "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.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "password": "A String", # The password for the replication connection.
+ "username": "A String", # The username for the replication connection.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "kind": "A String", # This is always *sql#mysqlReplicaConfiguration*.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "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.
+ "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.
+ },
+ "kind": "A String", # This is always *sql#replicaConfiguration*.
+ },
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
+ "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.
+ "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 for details.
}
x__xgafv: string, V1 error format.
@@ -2639,10 +2737,11 @@
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.
- "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
+ "user": "A String", # The email address of the user who initiated this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "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.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "kind": "A String", # This is always *sql#operationErrors*.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"code": "A String", # Identifies the specific error that occurred.
@@ -2650,49 +2749,9 @@
"kind": "A String", # This is always *sql#operationError*.
},
],
+ "kind": "A String", # This is always *sql#operationErrors*.
},
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetLink": "A String",
- "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.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "offload": True or False, # Option for export offload.
- "csvExportOptions": { # Options for exporting data as CSV.
- "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.
- "A String",
- ],
- "kind": "A String", # This is always *sql#exportContext*.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "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",
- ],
- "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
- },
- },
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
- },
- "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*
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "selfLink": "A String", # The URI of this resource.
- "kind": "A String", # This is always *sql#operation*.
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
- "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.
- "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
- "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",
- ],
- "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always *sql#importContext*.
"bakImportOptions": { # Import parameters specific to SQL Server .BAK files
"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.
@@ -2700,9 +2759,52 @@
"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.
},
},
+ "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.
+ "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.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "table": "A String", # The table to which CSV data is imported.
+ "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",
+ ],
+ },
+ "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.
},
- "user": "A String", # The email address of the user who initiated this operation.
+ "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
+ "targetLink": "A String",
"targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "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*
+ "kind": "A String", # This is always *sql#operation*.
+ "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*.
+ },
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "schemaOnly": True or False, # Export only schemas.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "kind": "A String", # This is always *sql#exportContext*.
+ "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
+ "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "offload": True or False, # Option for export offload.
+ "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
+ "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.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
}</pre>
</div>