| <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.users.html">users</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <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> | |
| <p class="firstline">Creates a new user in a Cloud SQL instance.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Lists users in the specified Cloud SQL instance.</p> | |
| <p class="toc_element"> | |
| <code><a href="#update">update(project, instance, body=None, host=None, name=None, x__xgafv=None)</a></code></p> | |
| <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, 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) | |
| 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 | |
| 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. | |
| "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. | |
| "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. | |
| "columns": [ # The columns to which CSV data is imported. If not specified, all columns | |
| # of the database table are loaded with CSV data. | |
| "A String", | |
| ], | |
| "table": "A String", # The table to which CSV data is imported. | |
| }, | |
| "database": "A String", # The target database for the import. If <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>. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code> | |
| <pre>Creates a new user in 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: | |
| { # A Cloud SQL user resource. | |
| "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", | |
| ], | |
| }, | |
| "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. | |
| "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. | |
| "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. | |
| } | |
| 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. | |
| "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. | |
| "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. | |
| "columns": [ # The columns to which CSV data is imported. If not specified, all columns | |
| # of the database table are loaded with CSV data. | |
| "A String", | |
| ], | |
| "table": "A String", # The table to which CSV data is imported. | |
| }, | |
| "database": "A String", # The target database for the import. If <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>. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(project, instance, x__xgafv=None)</code> | |
| <pre>Lists users in the specified 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) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # User list response. | |
| "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. | |
| "kind": "A String", # This is always <code>sql#usersList</code>. | |
| "items": [ # List of user resources in the instance. | |
| { # A Cloud SQL user resource. | |
| "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", | |
| ], | |
| }, | |
| "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. | |
| "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. | |
| "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. | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="update">update(project, instance, body=None, host=None, name=None, x__xgafv=None)</code> | |
| <pre>Updates an existing user in 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: | |
| { # A Cloud SQL user resource. | |
| "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", | |
| ], | |
| }, | |
| "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. | |
| "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. | |
| "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. | |
| } | |
| host: string, Optional. 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 | |
| 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. | |
| "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. | |
| "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. | |
| "columns": [ # The columns to which CSV data is imported. If not specified, all columns | |
| # of the database table are loaded with CSV data. | |
| "A String", | |
| ], | |
| "table": "A String", # The table to which CSV data is imported. | |
| }, | |
| "database": "A String", # The target database for the import. If <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>. | |
| }</pre> | |
| </div> | |
| </body></html> |