docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/sql_v1beta4.databases.html b/docs/dyn/sql_v1beta4.databases.html
new file mode 100644
index 0000000..bb4d280
--- /dev/null
+++ b/docs/dyn/sql_v1beta4.databases.html
@@ -0,0 +1,780 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="sql_v1beta4.html">Cloud SQL Admin API</a> . <a href="sql_v1beta4.databases.html">databases</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, instance, database, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a database from a Cloud SQL instance.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, instance, database, x__xgafv=None)</a></code></p>
+<p class="firstline">Retrieves a resource containing information about a database inside a Cloud</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Inserts a resource containing information about a database inside a Cloud</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists databases in the specified Cloud SQL instance.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(project, instance, database, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Partially updates a resource containing information about a database inside</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, instance, database, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates a resource containing information about a database inside a Cloud</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, instance, database, x__xgafv=None)</code>
+ <pre>Deletes a database from a Cloud SQL instance.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Database instance ID. This does not include the project ID. (required)
+ database: string, Name of the database to be deleted in the instance. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "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.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, 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 <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. 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. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "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.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "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",
+ ],
+ "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 <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, 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. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: 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 <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, instance, database, x__xgafv=None)</code>
+ <pre>Retrieves a resource containing information about a database inside a Cloud
+SQL instance.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Database instance ID. This does not include the project ID. (required)
+ database: string, Name of the database in the instance. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a SQL database on the Cloud SQL instance.
+ "sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance.
+ "recoveryModel": "A String", # The recovery model of a SQL Server database
+ "compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible
+ },
+ "charset": "A String", # The MySQL charset value.
+ "kind": "A String", # This is always <code>sql#database</code>.
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the
+ # API.
+ "collation": "A String", # The MySQL collation value.
+ "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
+ "name": "A String", # The name of the database in the Cloud SQL instance. This does not include
+ # the project ID or instance name.
+ "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google
+ # apps domain is prefixed if applicable.
+ "selfLink": "A String", # The URI of this resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
+ <pre>Inserts a resource containing information about a database inside a Cloud
+SQL instance.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Database instance ID. This does not include the project ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a SQL database on the Cloud SQL instance.
+ "sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance.
+ "recoveryModel": "A String", # The recovery model of a SQL Server database
+ "compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible
+ },
+ "charset": "A String", # The MySQL charset value.
+ "kind": "A String", # This is always <code>sql#database</code>.
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the
+ # API.
+ "collation": "A String", # The MySQL collation value.
+ "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
+ "name": "A String", # The name of the database in the Cloud SQL instance. This does not include
+ # the project ID or instance name.
+ "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google
+ # apps domain is prefixed if applicable.
+ "selfLink": "A String", # The URI of this resource.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "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.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, 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 <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. 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. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "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.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "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",
+ ],
+ "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 <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, 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. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: 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 <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, instance, x__xgafv=None)</code>
+ <pre>Lists databases in the specified Cloud SQL instance.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Database list response.
+ "kind": "A String", # This is always <code>sql#databasesList</code>.
+ "items": [ # List of database resources in the instance.
+ { # Represents a SQL database on the Cloud SQL instance.
+ "sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance.
+ "recoveryModel": "A String", # The recovery model of a SQL Server database
+ "compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible
+ },
+ "charset": "A String", # The MySQL charset value.
+ "kind": "A String", # This is always <code>sql#database</code>.
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the
+ # API.
+ "collation": "A String", # The MySQL collation value.
+ "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
+ "name": "A String", # The name of the database in the Cloud SQL instance. This does not include
+ # the project ID or instance name.
+ "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google
+ # apps domain is prefixed if applicable.
+ "selfLink": "A String", # The URI of this resource.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(project, instance, database, body=None, x__xgafv=None)</code>
+ <pre>Partially updates a resource containing information about a database inside
+a Cloud SQL instance. This method supports patch semantics.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Database instance ID. This does not include the project ID. (required)
+ database: string, Name of the database to be updated in the instance. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a SQL database on the Cloud SQL instance.
+ "sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance.
+ "recoveryModel": "A String", # The recovery model of a SQL Server database
+ "compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible
+ },
+ "charset": "A String", # The MySQL charset value.
+ "kind": "A String", # This is always <code>sql#database</code>.
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the
+ # API.
+ "collation": "A String", # The MySQL collation value.
+ "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
+ "name": "A String", # The name of the database in the Cloud SQL instance. This does not include
+ # the project ID or instance name.
+ "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google
+ # apps domain is prefixed if applicable.
+ "selfLink": "A String", # The URI of this resource.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "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.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, 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 <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. 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. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "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.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "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",
+ ],
+ "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 <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, 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. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: 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 <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, instance, database, body=None, x__xgafv=None)</code>
+ <pre>Updates a resource containing information about a database inside a Cloud
+SQL instance.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Database instance ID. This does not include the project ID. (required)
+ database: string, Name of the database to be updated in the instance. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a SQL database on the Cloud SQL instance.
+ "sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance.
+ "recoveryModel": "A String", # The recovery model of a SQL Server database
+ "compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible
+ },
+ "charset": "A String", # The MySQL charset value.
+ "kind": "A String", # This is always <code>sql#database</code>.
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the
+ # API.
+ "collation": "A String", # The MySQL collation value.
+ "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
+ "name": "A String", # The name of the database in the Cloud SQL instance. This does not include
+ # the project ID or instance name.
+ "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google
+ # apps domain is prefixed if applicable.
+ "selfLink": "A String", # The URI of this resource.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "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.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, 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 <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. 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. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "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.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "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",
+ ],
+ "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 <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, 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. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: 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 <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file