| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="sqladmin_v1.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1.users.html">users</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(project, instance, host=None, name=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes a user from a Cloud SQL instance.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Creates a new user in a Cloud SQL instance.</p> |
| 86 | <p class="toc_element"> |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 87 | <code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 88 | <p class="firstline">Lists users in the specified Cloud SQL instance.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#update">update(project, instance, body=None, host=None, name=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Updates an existing user in a Cloud SQL instance.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| 94 | <code class="details" id="close">close()</code> |
| 95 | <pre>Close httplib2 connections.</pre> |
| 96 | </div> |
| 97 | |
| 98 | <div class="method"> |
| 99 | <code class="details" id="delete">delete(project, instance, host=None, name=None, x__xgafv=None)</code> |
| 100 | <pre>Deletes a user from a Cloud SQL instance. |
| 101 | |
| 102 | Args: |
| 103 | project: string, Project ID of the project that contains the instance. (required) |
| 104 | instance: string, Database instance ID. This does not include the project ID. (required) |
| 105 | host: string, Host of the user in the instance. |
| 106 | name: string, Name of the user in the instance. |
| 107 | x__xgafv: string, V1 error format. |
| 108 | Allowed values |
| 109 | 1 - v1 error format |
| 110 | 2 - v2 error format |
| 111 | |
| 112 | Returns: |
| 113 | An object of the form: |
| 114 | |
| 115 | { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. |
| 116 | "backupContext": { # Backup context. # The context for backup operation, if applicable. |
| 117 | "backupId": "A String", # The identifier of the backup. |
| 118 | "kind": "A String", # This is always **sql#backupContext**. |
| 119 | }, |
| 120 | "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. |
| 121 | "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. |
| 122 | "errors": [ # The list of errors encountered while processing this operation. |
| 123 | { # Database instance operation error. |
| 124 | "code": "A String", # Identifies the specific error that occurred. |
| 125 | "kind": "A String", # This is always **sql#operationError**. |
| 126 | "message": "A String", # Additional information about the error encountered. |
| 127 | }, |
| 128 | ], |
| 129 | "kind": "A String", # This is always **sql#operationErrors**. |
| 130 | }, |
| 131 | "exportContext": { # Database instance export context. # The context for export operation, if applicable. |
| 132 | "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 133 | "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. |
| 134 | "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. |
| 135 | "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. |
| 136 | "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 137 | "selectQuery": "A String", # The select query used to extract the data. |
| 138 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 139 | "databases": [ # Databases to be exported. * **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. * **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. * **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 140 | "A String", |
| 141 | ], |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 142 | "fileType": "A String", # The file type for the specified uri. * **SQL**: The file contains SQL statements. * **CSV**: The file contains CSV data. * **BAK**: The file contains backup data for a SQL Server instance. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 143 | "kind": "A String", # This is always **sql#exportContext**. |
| 144 | "offload": True or False, # Option for export offload. |
| 145 | "sqlExportOptions": { # Options for exporting data as SQL statements. |
| 146 | "mysqlExportOptions": { # Options for exporting from MySQL. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 147 | "masterData": 42, # Option to include SQL statement required to set up replication. * If set to **1**, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. * If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. * If set to any value other than **1**, --set-gtid-purged is set to OFF. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 148 | }, |
| 149 | "schemaOnly": True or False, # Export only schemas. |
| 150 | "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. |
| 151 | "A String", |
| 152 | ], |
| 153 | }, |
| 154 | "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. |
| 155 | }, |
| 156 | "importContext": { # Database instance import context. # The context for import operation, if applicable. |
| 157 | "bakImportOptions": { # Import parameters specific to SQL Server .BAK files |
| 158 | "encryptionOptions": { |
| 159 | "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. |
| 160 | "pvkPassword": "A String", # Password that encrypts the private key |
| 161 | "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. |
| 162 | }, |
| 163 | }, |
| 164 | "csvImportOptions": { # Options for importing data as CSV. |
| 165 | "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. |
| 166 | "A String", |
| 167 | ], |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 168 | "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. |
| 169 | "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. |
| 170 | "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. |
| 171 | "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 172 | "table": "A String", # The table to which CSV data is imported. |
| 173 | }, |
| 174 | "database": "A String", # The target database for the import. If **fileType** is **SQL**, 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 **fileType** is **CSV**, one database must be specified. |
| 175 | "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. |
| 176 | "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. |
| 177 | "kind": "A String", # This is always **sql#importContext**. |
| 178 | "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. |
| 179 | }, |
| 180 | "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. |
| 181 | "kind": "A String", # This is always **sql#operation**. |
| 182 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 183 | "operationType": "A String", # The type of the operation. Valid values are: * **CREATE** * **DELETE** * **UPDATE** * **RESTART** * **IMPORT** * **EXPORT** * **BACKUP_VOLUME** * **RESTORE_VOLUME** * **CREATE_USER** * **DELETE_USER** * **CREATE_DATABASE** * **DELETE_DATABASE** |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 184 | "selfLink": "A String", # The URI of this resource. |
| 185 | "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 186 | "status": "A String", # The status of an operation. Valid values are: * **PENDING** * **RUNNING** * **DONE** * **SQL_OPERATION_STATUS_UNSPECIFIED** |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 187 | "targetId": "A String", # Name of the database instance related to this operation. |
| 188 | "targetLink": "A String", |
| 189 | "targetProject": "A String", # The project ID of the target instance related to this operation. |
| 190 | "user": "A String", # The email address of the user who initiated this operation. |
| 191 | }</pre> |
| 192 | </div> |
| 193 | |
| 194 | <div class="method"> |
| 195 | <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code> |
| 196 | <pre>Creates a new user in a Cloud SQL instance. |
| 197 | |
| 198 | Args: |
| 199 | project: string, Project ID of the project that contains the instance. (required) |
| 200 | instance: string, Database instance ID. This does not include the project ID. (required) |
| 201 | body: object, The request body. |
| 202 | The object takes the form of: |
| 203 | |
| 204 | { # A Cloud SQL user resource. |
| 205 | "etag": "A String", # This field is deprecated and will be removed from a future version of the API. |
| yoshi-code-bot | 1c9dcfd | 2021-10-12 00:20:31 -0700 | [diff] [blame] | 206 | "host": "A String", # The host name from which the user can connect. For **insert** operations, host defaults to an empty string. For **update** operations, host is specified as part of the request URL. The host name cannot be updated after insertion. |
| 207 | "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for **update** since it is already specified on the URL. |
| 208 | "kind": "A String", # This is always **sql#user**. |
| 209 | "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for **update** since it is already specified in the URL. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 210 | "password": "A String", # The password for the user. |
| yoshi-code-bot | 1c9dcfd | 2021-10-12 00:20:31 -0700 | [diff] [blame] | 211 | "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 **update** since it is already specified on the URL. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 212 | "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance. |
| 213 | "disabled": True or False, # If the user has been disabled |
| 214 | "serverRoles": [ # The server roles for this user |
| 215 | "A String", |
| 216 | ], |
| 217 | }, |
| 218 | "type": "A String", # The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type. |
| 219 | } |
| 220 | |
| 221 | x__xgafv: string, V1 error format. |
| 222 | Allowed values |
| 223 | 1 - v1 error format |
| 224 | 2 - v2 error format |
| 225 | |
| 226 | Returns: |
| 227 | An object of the form: |
| 228 | |
| 229 | { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. |
| 230 | "backupContext": { # Backup context. # The context for backup operation, if applicable. |
| 231 | "backupId": "A String", # The identifier of the backup. |
| 232 | "kind": "A String", # This is always **sql#backupContext**. |
| 233 | }, |
| 234 | "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. |
| 235 | "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. |
| 236 | "errors": [ # The list of errors encountered while processing this operation. |
| 237 | { # Database instance operation error. |
| 238 | "code": "A String", # Identifies the specific error that occurred. |
| 239 | "kind": "A String", # This is always **sql#operationError**. |
| 240 | "message": "A String", # Additional information about the error encountered. |
| 241 | }, |
| 242 | ], |
| 243 | "kind": "A String", # This is always **sql#operationErrors**. |
| 244 | }, |
| 245 | "exportContext": { # Database instance export context. # The context for export operation, if applicable. |
| 246 | "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 247 | "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. |
| 248 | "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. |
| 249 | "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. |
| 250 | "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 251 | "selectQuery": "A String", # The select query used to extract the data. |
| 252 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 253 | "databases": [ # Databases to be exported. * **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. * **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. * **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 254 | "A String", |
| 255 | ], |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 256 | "fileType": "A String", # The file type for the specified uri. * **SQL**: The file contains SQL statements. * **CSV**: The file contains CSV data. * **BAK**: The file contains backup data for a SQL Server instance. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 257 | "kind": "A String", # This is always **sql#exportContext**. |
| 258 | "offload": True or False, # Option for export offload. |
| 259 | "sqlExportOptions": { # Options for exporting data as SQL statements. |
| 260 | "mysqlExportOptions": { # Options for exporting from MySQL. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 261 | "masterData": 42, # Option to include SQL statement required to set up replication. * If set to **1**, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. * If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. * If set to any value other than **1**, --set-gtid-purged is set to OFF. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 262 | }, |
| 263 | "schemaOnly": True or False, # Export only schemas. |
| 264 | "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. |
| 265 | "A String", |
| 266 | ], |
| 267 | }, |
| 268 | "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. |
| 269 | }, |
| 270 | "importContext": { # Database instance import context. # The context for import operation, if applicable. |
| 271 | "bakImportOptions": { # Import parameters specific to SQL Server .BAK files |
| 272 | "encryptionOptions": { |
| 273 | "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. |
| 274 | "pvkPassword": "A String", # Password that encrypts the private key |
| 275 | "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. |
| 276 | }, |
| 277 | }, |
| 278 | "csvImportOptions": { # Options for importing data as CSV. |
| 279 | "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. |
| 280 | "A String", |
| 281 | ], |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 282 | "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. |
| 283 | "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. |
| 284 | "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. |
| 285 | "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 286 | "table": "A String", # The table to which CSV data is imported. |
| 287 | }, |
| 288 | "database": "A String", # The target database for the import. If **fileType** is **SQL**, 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 **fileType** is **CSV**, one database must be specified. |
| 289 | "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. |
| 290 | "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. |
| 291 | "kind": "A String", # This is always **sql#importContext**. |
| 292 | "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. |
| 293 | }, |
| 294 | "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. |
| 295 | "kind": "A String", # This is always **sql#operation**. |
| 296 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 297 | "operationType": "A String", # The type of the operation. Valid values are: * **CREATE** * **DELETE** * **UPDATE** * **RESTART** * **IMPORT** * **EXPORT** * **BACKUP_VOLUME** * **RESTORE_VOLUME** * **CREATE_USER** * **DELETE_USER** * **CREATE_DATABASE** * **DELETE_DATABASE** |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 298 | "selfLink": "A String", # The URI of this resource. |
| 299 | "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 300 | "status": "A String", # The status of an operation. Valid values are: * **PENDING** * **RUNNING** * **DONE** * **SQL_OPERATION_STATUS_UNSPECIFIED** |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 301 | "targetId": "A String", # Name of the database instance related to this operation. |
| 302 | "targetLink": "A String", |
| 303 | "targetProject": "A String", # The project ID of the target instance related to this operation. |
| 304 | "user": "A String", # The email address of the user who initiated this operation. |
| 305 | }</pre> |
| 306 | </div> |
| 307 | |
| 308 | <div class="method"> |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 309 | <code class="details" id="list">list(project, instance, x__xgafv=None)</code> |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 310 | <pre>Lists users in the specified Cloud SQL instance. |
| 311 | |
| 312 | Args: |
| 313 | project: string, Project ID of the project that contains the instance. (required) |
| 314 | instance: string, Database instance ID. This does not include the project ID. (required) |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 315 | x__xgafv: string, V1 error format. |
| 316 | Allowed values |
| 317 | 1 - v1 error format |
| 318 | 2 - v2 error format |
| 319 | |
| 320 | Returns: |
| 321 | An object of the form: |
| 322 | |
| 323 | { # User list response. |
| 324 | "items": [ # List of user resources in the instance. |
| 325 | { # A Cloud SQL user resource. |
| 326 | "etag": "A String", # This field is deprecated and will be removed from a future version of the API. |
| yoshi-code-bot | 1c9dcfd | 2021-10-12 00:20:31 -0700 | [diff] [blame] | 327 | "host": "A String", # The host name from which the user can connect. For **insert** operations, host defaults to an empty string. For **update** operations, host is specified as part of the request URL. The host name cannot be updated after insertion. |
| 328 | "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for **update** since it is already specified on the URL. |
| 329 | "kind": "A String", # This is always **sql#user**. |
| 330 | "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for **update** since it is already specified in the URL. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 331 | "password": "A String", # The password for the user. |
| yoshi-code-bot | 1c9dcfd | 2021-10-12 00:20:31 -0700 | [diff] [blame] | 332 | "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 **update** since it is already specified on the URL. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 333 | "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance. |
| 334 | "disabled": True or False, # If the user has been disabled |
| 335 | "serverRoles": [ # The server roles for this user |
| 336 | "A String", |
| 337 | ], |
| 338 | }, |
| 339 | "type": "A String", # The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type. |
| 340 | }, |
| 341 | ], |
| yoshi-code-bot | 1c9dcfd | 2021-10-12 00:20:31 -0700 | [diff] [blame] | 342 | "kind": "A String", # This is always **sql#usersList**. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 343 | "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. |
| 344 | }</pre> |
| 345 | </div> |
| 346 | |
| 347 | <div class="method"> |
| 348 | <code class="details" id="update">update(project, instance, body=None, host=None, name=None, x__xgafv=None)</code> |
| 349 | <pre>Updates an existing user in a Cloud SQL instance. |
| 350 | |
| 351 | Args: |
| 352 | project: string, Project ID of the project that contains the instance. (required) |
| 353 | instance: string, Database instance ID. This does not include the project ID. (required) |
| 354 | body: object, The request body. |
| 355 | The object takes the form of: |
| 356 | |
| 357 | { # A Cloud SQL user resource. |
| 358 | "etag": "A String", # This field is deprecated and will be removed from a future version of the API. |
| yoshi-code-bot | 1c9dcfd | 2021-10-12 00:20:31 -0700 | [diff] [blame] | 359 | "host": "A String", # The host name from which the user can connect. For **insert** operations, host defaults to an empty string. For **update** operations, host is specified as part of the request URL. The host name cannot be updated after insertion. |
| 360 | "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for **update** since it is already specified on the URL. |
| 361 | "kind": "A String", # This is always **sql#user**. |
| 362 | "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for **update** since it is already specified in the URL. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 363 | "password": "A String", # The password for the user. |
| yoshi-code-bot | 1c9dcfd | 2021-10-12 00:20:31 -0700 | [diff] [blame] | 364 | "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 **update** since it is already specified on the URL. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 365 | "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance. |
| 366 | "disabled": True or False, # If the user has been disabled |
| 367 | "serverRoles": [ # The server roles for this user |
| 368 | "A String", |
| 369 | ], |
| 370 | }, |
| 371 | "type": "A String", # The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type. |
| 372 | } |
| 373 | |
| 374 | host: string, Optional. Host of the user in the instance. |
| 375 | name: string, Name of the user in the instance. |
| 376 | x__xgafv: string, V1 error format. |
| 377 | Allowed values |
| 378 | 1 - v1 error format |
| 379 | 2 - v2 error format |
| 380 | |
| 381 | Returns: |
| 382 | An object of the form: |
| 383 | |
| 384 | { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. |
| 385 | "backupContext": { # Backup context. # The context for backup operation, if applicable. |
| 386 | "backupId": "A String", # The identifier of the backup. |
| 387 | "kind": "A String", # This is always **sql#backupContext**. |
| 388 | }, |
| 389 | "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. |
| 390 | "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. |
| 391 | "errors": [ # The list of errors encountered while processing this operation. |
| 392 | { # Database instance operation error. |
| 393 | "code": "A String", # Identifies the specific error that occurred. |
| 394 | "kind": "A String", # This is always **sql#operationError**. |
| 395 | "message": "A String", # Additional information about the error encountered. |
| 396 | }, |
| 397 | ], |
| 398 | "kind": "A String", # This is always **sql#operationErrors**. |
| 399 | }, |
| 400 | "exportContext": { # Database instance export context. # The context for export operation, if applicable. |
| 401 | "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 402 | "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. |
| 403 | "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. |
| 404 | "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. |
| 405 | "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 406 | "selectQuery": "A String", # The select query used to extract the data. |
| 407 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 408 | "databases": [ # Databases to be exported. * **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. * **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. * **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 409 | "A String", |
| 410 | ], |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 411 | "fileType": "A String", # The file type for the specified uri. * **SQL**: The file contains SQL statements. * **CSV**: The file contains CSV data. * **BAK**: The file contains backup data for a SQL Server instance. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 412 | "kind": "A String", # This is always **sql#exportContext**. |
| 413 | "offload": True or False, # Option for export offload. |
| 414 | "sqlExportOptions": { # Options for exporting data as SQL statements. |
| 415 | "mysqlExportOptions": { # Options for exporting from MySQL. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 416 | "masterData": 42, # Option to include SQL statement required to set up replication. * If set to **1**, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. * If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. * If set to any value other than **1**, --set-gtid-purged is set to OFF. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 417 | }, |
| 418 | "schemaOnly": True or False, # Export only schemas. |
| 419 | "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. |
| 420 | "A String", |
| 421 | ], |
| 422 | }, |
| 423 | "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. |
| 424 | }, |
| 425 | "importContext": { # Database instance import context. # The context for import operation, if applicable. |
| 426 | "bakImportOptions": { # Import parameters specific to SQL Server .BAK files |
| 427 | "encryptionOptions": { |
| 428 | "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. |
| 429 | "pvkPassword": "A String", # Password that encrypts the private key |
| 430 | "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. |
| 431 | }, |
| 432 | }, |
| 433 | "csvImportOptions": { # Options for importing data as CSV. |
| 434 | "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. |
| 435 | "A String", |
| 436 | ], |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 437 | "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. |
| 438 | "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. |
| 439 | "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. |
| 440 | "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 441 | "table": "A String", # The table to which CSV data is imported. |
| 442 | }, |
| 443 | "database": "A String", # The target database for the import. If **fileType** is **SQL**, 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 **fileType** is **CSV**, one database must be specified. |
| 444 | "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. |
| 445 | "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. |
| 446 | "kind": "A String", # This is always **sql#importContext**. |
| 447 | "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. |
| 448 | }, |
| 449 | "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. |
| 450 | "kind": "A String", # This is always **sql#operation**. |
| 451 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 452 | "operationType": "A String", # The type of the operation. Valid values are: * **CREATE** * **DELETE** * **UPDATE** * **RESTART** * **IMPORT** * **EXPORT** * **BACKUP_VOLUME** * **RESTORE_VOLUME** * **CREATE_USER** * **DELETE_USER** * **CREATE_DATABASE** * **DELETE_DATABASE** |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 453 | "selfLink": "A String", # The URI of this resource. |
| 454 | "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame] | 455 | "status": "A String", # The status of an operation. Valid values are: * **PENDING** * **RUNNING** * **DONE** * **SQL_OPERATION_STATUS_UNSPECIFIED** |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 456 | "targetId": "A String", # Name of the database instance related to this operation. |
| 457 | "targetLink": "A String", |
| 458 | "targetProject": "A String", # The project ID of the target instance related to this operation. |
| 459 | "user": "A String", # The email address of the user who initiated this operation. |
| 460 | }</pre> |
| 461 | </div> |
| 462 | |
| 463 | </body></html> |