docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/sql_v1beta4.backupRuns.html b/docs/dyn/sql_v1beta4.backupRuns.html
index 62aee51..3e4a7d5 100644
--- a/docs/dyn/sql_v1beta4.backupRuns.html
+++ b/docs/dyn/sql_v1beta4.backupRuns.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new backup run on demand. This method is applicable only to</p>
<p class="toc_element">
- <code><a href="#list">list(project, instance, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all backup runs associated with a given instance and configuration in</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -111,6 +111,61 @@
{ # An Operation resource.&nbsp;For successful operations that return an
# Operation resource, only the fields relevant to the operation are populated
# in the 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.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ "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.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "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.
+ },
+ },
+ "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>.
"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.
@@ -125,15 +180,16 @@
# populated.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
"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.
+ "kind": "A String", # This is always <code>sql#importContext</code>.
"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.
@@ -141,7 +197,6 @@
],
"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
@@ -170,61 +225,6 @@
"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>
@@ -245,6 +245,7 @@
An object of the form:
{ # A BackupRun resource.
+ "instance": "A String", # Name of the database instance.
"type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
"windowStartTime": "A String", # The start time of the backup window during which this the backup was
# attempted in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a>
@@ -258,15 +259,15 @@
"kind": "A String", # This is always <code>sql#backupRun</code>.
"error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if
# the run has the FAILED status.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
"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>.
},
"description": "A String", # The description of this run, only applicable to on-demand backups.
"diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
# Applies only to Second Generation instances.
- "kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.
"kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ "kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.
},
"status": "A String", # The status of this run.
"enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in <a
@@ -281,7 +282,6 @@
"startTime": "A String", # The time the backup 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>.
- "instance": "A String", # Name of the database instance.
}</pre>
</div>
@@ -297,6 +297,7 @@
The object takes the form of:
{ # A BackupRun resource.
+ "instance": "A String", # Name of the database instance.
"type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
"windowStartTime": "A String", # The start time of the backup window during which this the backup was
# attempted in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a>
@@ -310,15 +311,15 @@
"kind": "A String", # This is always <code>sql#backupRun</code>.
"error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if
# the run has the FAILED status.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
"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>.
},
"description": "A String", # The description of this run, only applicable to on-demand backups.
"diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
# Applies only to Second Generation instances.
- "kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.
"kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ "kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.
},
"status": "A String", # The status of this run.
"enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in <a
@@ -333,7 +334,6 @@
"startTime": "A String", # The time the backup 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>.
- "instance": "A String", # Name of the database instance.
}
x__xgafv: string, V1 error format.
@@ -347,6 +347,61 @@
{ # An Operation resource.&nbsp;For successful operations that return an
# Operation resource, only the fields relevant to the operation are populated
# in the 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.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ "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.
+ "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.
+ },
+ "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",
+ ],
+ },
+ "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.
+ },
+ },
+ "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>.
"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.
@@ -361,15 +416,16 @@
# populated.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
"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.
+ "kind": "A String", # This is always <code>sql#importContext</code>.
"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.
@@ -377,7 +433,6 @@
],
"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
@@ -406,75 +461,20 @@
"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, pageToken=None, maxResults=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all backup runs associated with a given instance and configuration in
the reverse chronological order of the backup initiation time.
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)
+ maxResults: integer, Maximum number of backup runs per response.
pageToken: string, A previously-returned page token representing part of the larger set of
results to view.
- maxResults: integer, Maximum number of backup runs per response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -489,6 +489,7 @@
"kind": "A String", # This is always <code>sql#backupRunsList</code>.
"items": [ # A list of backup runs in reverse chronological order of the enqueued time.
{ # A BackupRun resource.
+ "instance": "A String", # Name of the database instance.
"type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
"windowStartTime": "A String", # The start time of the backup window during which this the backup was
# attempted in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a>
@@ -502,15 +503,15 @@
"kind": "A String", # This is always <code>sql#backupRun</code>.
"error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if
# the run has the FAILED status.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
"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>.
},
"description": "A String", # The description of this run, only applicable to on-demand backups.
"diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
# Applies only to Second Generation instances.
- "kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.
"kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ "kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.
},
"status": "A String", # The status of this run.
"enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in <a
@@ -525,7 +526,6 @@
"startTime": "A String", # The time the backup 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>.
- "instance": "A String", # Name of the database instance.
},
],
}</pre>