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/sqladmin_v1beta4.users.html b/docs/dyn/sqladmin_v1beta4.users.html
index 0d596aa..f8c659b 100644
--- a/docs/dyn/sqladmin_v1beta4.users.html
+++ b/docs/dyn/sqladmin_v1beta4.users.html
@@ -75,7 +75,7 @@
<h1><a href="sqladmin_v1beta4.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1beta4.users.html">users</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(project, instance, name=None, host=None, x__xgafv=None)</a></code></p>
+ <code><a href="#delete">delete(project, instance, host=None, name=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a user from a Cloud SQL instance.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>
@@ -88,14 +88,14 @@
<p class="firstline">Updates an existing user in a Cloud SQL instance.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(project, instance, name=None, host=None, x__xgafv=None)</code>
+ <code class="details" id="delete">delete(project, instance, host=None, name=None, x__xgafv=None)</code>
<pre>Deletes a user 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)
- name: string, Name of the user in the instance.
host: string, Host of the user in the instance.
+ name: string, Name of the user in the instance.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -107,62 +107,79 @@
{ # An Operation resource.&nbsp;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 <code>PENDING</code>,
- # <code>RUNNING</code>, <code>DONE</code>,
- # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
- "importContext": { # Database instance import context. # The context for import operation, if applicable.
- "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
- "encryptionOptions": {
- "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.
- "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.
- "pvkPassword": "A String", # Password that encrypts the private key
+ "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.
+ "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.
+ "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#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.
+ "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",
+ ],
},
- "kind": "A String", # This is always <code>sql#importContext</code>.
- "database": "A String", # The target database for the import. If <code>fileType</code> is
+ "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.
- "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", # Path to the import file in Cloud Storage, in the form
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "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.
+ "pvkPassword": "A String", # Password that encrypts the private key
+ },
+ },
+ "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "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. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
},
- "kind": "A String", # This is always <code>sql#operation</code>.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
- "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ "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.
- "kind": "A String", # This is always <code>sql#exportContext</code>.
- "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.
- },
- "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ "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,
@@ -172,55 +189,38 @@
# 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",
+ "A String",
],
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "tables": [ # Tables to export, or that were exported, from the specified database. If
+ "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",
+ "A String",
],
- "mysqlExportOptions": { # Options for exporting from MySQL.
- "masterData": 42, # Option to include SQL statement required to set up replication.
+ "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.
},
- "schemaOnly": True or False, # Export only schemas.
},
+ "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>.
},
- "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>.
- "targetId": "A String", # Name of the database instance related to this operation.
- "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> .
- "user": "A String", # The email address of the user who initiated this operation.
- "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>.
- "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 <code>sql#operationErrors</code>.
- "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.
- },
- ],
- },
- "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>.
- "selfLink": "A String", # The URI of this resource.
- "targetLink": "A String",
+ "targetId": "A String", # Name of the database instance related to this operation.
}</pre>
</div>
@@ -235,28 +235,28 @@
The object takes the form of:
{ # A Cloud SQL user resource.
- "kind": "A String", # This is always <code>sql#user</code>.
- "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for
- # <code>update</code> since it is already specified in the URL.
- "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google
- # apps domain is prefixed if applicable. Can be omitted for
- # <code>update</code> since it is already specified on the URL.
- "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
- # Can be omitted for <code>update</code> since it is already specified on the
- # URL.
- "host": "A String", # The host name from which the user can connect. For <code>insert</code>
+ "host": "A String", # The host name from which the user can connect. For <code>insert</code>
# operations, host defaults to an empty string. For <code>update</code>
# operations, host is specified as part of the request URL. The host name
# cannot be updated after insertion.
- "etag": "A String", # This field is deprecated and will be removed from a future version of the
+ "kind": "A String", # This is always <code>sql#user</code>.
+ "password": "A String", # The password for the user.
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the
# API.
- "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance.
- "disabled": True or False, # If the user has been disabled
- "serverRoles": [ # The server roles for this user
- "A String",
+ "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance.
+ "disabled": True or False, # If the user has been disabled
+ "serverRoles": [ # The server roles for this user
+ "A String",
],
},
- "password": "A String", # The password for the user.
+ "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for
+ # <code>update</code> since it is already specified in the URL.
+ "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
+ # Can be omitted for <code>update</code> since it is already specified on the
+ # URL.
+ "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google
+ # apps domain is prefixed if applicable. Can be omitted for
+ # <code>update</code> since it is already specified on the URL.
}
x__xgafv: string, V1 error format.
@@ -270,62 +270,79 @@
{ # An Operation resource.&nbsp;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 <code>PENDING</code>,
- # <code>RUNNING</code>, <code>DONE</code>,
- # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
- "importContext": { # Database instance import context. # The context for import operation, if applicable.
- "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
- "encryptionOptions": {
- "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.
- "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.
- "pvkPassword": "A String", # Password that encrypts the private key
+ "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.
+ "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.
+ "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#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.
+ "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",
+ ],
},
- "kind": "A String", # This is always <code>sql#importContext</code>.
- "database": "A String", # The target database for the import. If <code>fileType</code> is
+ "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.
- "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", # Path to the import file in Cloud Storage, in the form
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "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.
+ "pvkPassword": "A String", # Password that encrypts the private key
+ },
+ },
+ "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "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. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
},
- "kind": "A String", # This is always <code>sql#operation</code>.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
- "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ "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.
- "kind": "A String", # This is always <code>sql#exportContext</code>.
- "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.
- },
- "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ "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,
@@ -335,55 +352,38 @@
# 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",
+ "A String",
],
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "tables": [ # Tables to export, or that were exported, from the specified database. If
+ "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",
+ "A String",
],
- "mysqlExportOptions": { # Options for exporting from MySQL.
- "masterData": 42, # Option to include SQL statement required to set up replication.
+ "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.
},
- "schemaOnly": True or False, # Export only schemas.
},
+ "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>.
},
- "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>.
- "targetId": "A String", # Name of the database instance related to this operation.
- "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> .
- "user": "A String", # The email address of the user who initiated this operation.
- "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>.
- "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 <code>sql#operationErrors</code>.
- "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.
- },
- ],
- },
- "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>.
- "selfLink": "A String", # The URI of this resource.
- "targetLink": "A String",
+ "targetId": "A String", # Name of the database instance related to this operation.
}</pre>
</div>
@@ -403,36 +403,36 @@
An object of the form:
{ # User list response.
- "nextPageToken": "A String", # An identifier that uniquely identifies the operation. You can use this
+ "nextPageToken": "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.
- "items": [ # List of user resources in the instance.
+ "kind": "A String", # This is always <code>sql#usersList</code>.
+ "items": [ # List of user resources in the instance.
{ # A Cloud SQL user resource.
- "kind": "A String", # This is always <code>sql#user</code>.
- "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for
- # <code>update</code> since it is already specified in the URL.
- "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google
- # apps domain is prefixed if applicable. Can be omitted for
- # <code>update</code> since it is already specified on the URL.
- "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
- # Can be omitted for <code>update</code> since it is already specified on the
- # URL.
- "host": "A String", # The host name from which the user can connect. For <code>insert</code>
+ "host": "A String", # The host name from which the user can connect. For <code>insert</code>
# operations, host defaults to an empty string. For <code>update</code>
# operations, host is specified as part of the request URL. The host name
# cannot be updated after insertion.
- "etag": "A String", # This field is deprecated and will be removed from a future version of the
+ "kind": "A String", # This is always <code>sql#user</code>.
+ "password": "A String", # The password for the user.
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the
# API.
- "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance.
- "disabled": True or False, # If the user has been disabled
- "serverRoles": [ # The server roles for this user
- "A String",
+ "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance.
+ "disabled": True or False, # If the user has been disabled
+ "serverRoles": [ # The server roles for this user
+ "A String",
],
},
- "password": "A String", # The password for the user.
+ "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for
+ # <code>update</code> since it is already specified in the URL.
+ "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
+ # Can be omitted for <code>update</code> since it is already specified on the
+ # URL.
+ "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google
+ # apps domain is prefixed if applicable. Can be omitted for
+ # <code>update</code> since it is already specified on the URL.
},
],
- "kind": "A String", # This is always <code>sql#usersList</code>.
}</pre>
</div>
@@ -447,28 +447,28 @@
The object takes the form of:
{ # A Cloud SQL user resource.
- "kind": "A String", # This is always <code>sql#user</code>.
- "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for
- # <code>update</code> since it is already specified in the URL.
- "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google
- # apps domain is prefixed if applicable. Can be omitted for
- # <code>update</code> since it is already specified on the URL.
- "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
- # Can be omitted for <code>update</code> since it is already specified on the
- # URL.
- "host": "A String", # The host name from which the user can connect. For <code>insert</code>
+ "host": "A String", # The host name from which the user can connect. For <code>insert</code>
# operations, host defaults to an empty string. For <code>update</code>
# operations, host is specified as part of the request URL. The host name
# cannot be updated after insertion.
- "etag": "A String", # This field is deprecated and will be removed from a future version of the
+ "kind": "A String", # This is always <code>sql#user</code>.
+ "password": "A String", # The password for the user.
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the
# API.
- "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance.
- "disabled": True or False, # If the user has been disabled
- "serverRoles": [ # The server roles for this user
- "A String",
+ "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance.
+ "disabled": True or False, # If the user has been disabled
+ "serverRoles": [ # The server roles for this user
+ "A String",
],
},
- "password": "A String", # The password for the user.
+ "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for
+ # <code>update</code> since it is already specified in the URL.
+ "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
+ # Can be omitted for <code>update</code> since it is already specified on the
+ # URL.
+ "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google
+ # apps domain is prefixed if applicable. Can be omitted for
+ # <code>update</code> since it is already specified on the URL.
}
name: string, Name of the user in the instance.
@@ -484,62 +484,79 @@
{ # An Operation resource.&nbsp;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 <code>PENDING</code>,
- # <code>RUNNING</code>, <code>DONE</code>,
- # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
- "importContext": { # Database instance import context. # The context for import operation, if applicable.
- "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
- "encryptionOptions": {
- "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.
- "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.
- "pvkPassword": "A String", # Password that encrypts the private key
+ "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.
+ "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.
+ "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#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.
+ "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",
+ ],
},
- "kind": "A String", # This is always <code>sql#importContext</code>.
- "database": "A String", # The target database for the import. If <code>fileType</code> is
+ "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.
- "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", # Path to the import file in Cloud Storage, in the form
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "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.
+ "pvkPassword": "A String", # Password that encrypts the private key
+ },
+ },
+ "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.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "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. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
},
- "kind": "A String", # This is always <code>sql#operation</code>.
- "targetProject": "A String", # The project ID of the target instance related to this operation.
- "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ "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.
- "kind": "A String", # This is always <code>sql#exportContext</code>.
- "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.
- },
- "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ "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,
@@ -549,55 +566,38 @@
# 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",
+ "A String",
],
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "tables": [ # Tables to export, or that were exported, from the specified database. If
+ "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",
+ "A String",
],
- "mysqlExportOptions": { # Options for exporting from MySQL.
- "masterData": 42, # Option to include SQL statement required to set up replication.
+ "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.
},
- "schemaOnly": True or False, # Export only schemas.
},
+ "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>.
},
- "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>.
- "targetId": "A String", # Name of the database instance related to this operation.
- "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> .
- "user": "A String", # The email address of the user who initiated this operation.
- "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>.
- "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 <code>sql#operationErrors</code>.
- "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.
- },
- ],
- },
- "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>.
- "selfLink": "A String", # The URI of this resource.
- "targetLink": "A String",
+ "targetId": "A String", # Name of the database instance related to this operation.
}</pre>
</div>