docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/sql_v1beta4.projects.instances.html b/docs/dyn/sql_v1beta4.projects.instances.html
index b816bcd..ce20517 100644
--- a/docs/dyn/sql_v1beta4.projects.instances.html
+++ b/docs/dyn/sql_v1beta4.projects.instances.html
@@ -81,7 +81,7 @@
<code><a href="#startExternalSync">startExternalSync(project, instance, syncMode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Start External master migration.</p>
<p class="toc_element">
- <code><a href="#verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, verifyConnectionOnly=None, syncMode=None, x__xgafv=None)</a></code></p>
+ <code><a href="#verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, syncMode=None, verifyConnectionOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Verify External master external sync settings.</p>
<h3>Method Details</h3>
<div class="method">
@@ -115,6 +115,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.
@@ -129,15 +184,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.
@@ -145,7 +201,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
@@ -174,61 +229,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>
@@ -251,6 +251,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.
@@ -265,15 +320,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.
@@ -281,7 +337,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
@@ -310,73 +365,18 @@
"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="verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, verifyConnectionOnly=None, syncMode=None, x__xgafv=None)</code>
+ <code class="details" id="verifyExternalSyncSettings">verifyExternalSyncSettings(project, instance, syncMode=None, verifyConnectionOnly=None, x__xgafv=None)</code>
<pre>Verify External master external sync settings.
Args:
project: string, Project ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
- verifyConnectionOnly: boolean, Flag to enable verifying connection only
syncMode: string, External sync mode
+ verifyConnectionOnly: boolean, Flag to enable verifying connection only
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -388,9 +388,9 @@
{ # Instance verify external sync settings response.
"errors": [ # List of migration violations.
{ # External master migration setting error.
+ "detail": "A String", # Additional information about the error encountered.
"kind": "A String", # This is always <code>sql#migrationSettingError</code>.
"type": "A String", # Identifies the specific error that occurred.
- "detail": "A String", # Additional information about the error encountered.
},
],
"kind": "A String", # This is always <code>sql#migrationSettingErrorList</code>.