| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [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 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 75 | <h1><a href="sqladmin_v1beta4.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1beta4.users.html">users</a></h1> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 81 | <code><a href="#delete">delete(project, instance, name=None, host=None, x__xgafv=None)</a></code></p> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 82 | <p class="firstline">Deletes a user from a Cloud SQL instance.</p> |
| 83 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 84 | <code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 85 | <p class="firstline">Creates a new user in a Cloud SQL instance.</p> |
| 86 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 87 | <code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 88 | <p class="firstline">Lists users in the specified Cloud SQL instance.</p> |
| 89 | <p class="toc_element"> |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 90 | <code><a href="#update">update(project, instance, body=None, host=None, name=None, x__xgafv=None)</a></code></p> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 91 | <p class="firstline">Updates an existing user in a Cloud SQL instance.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 94 | <code class="details" id="close">close()</code> |
| 95 | <pre>Close httplib2 connections.</pre> |
| 96 | </div> |
| 97 | |
| 98 | <div class="method"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 99 | <code class="details" id="delete">delete(project, instance, name=None, host=None, x__xgafv=None)</code> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 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) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 105 | name: string, Name of the user in the instance. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 106 | host: string, Host of the user in the instance. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 107 | x__xgafv: string, V1 error format. |
| 108 | Allowed values |
| 109 | 1 - v1 error format |
| 110 | 2 - v2 error format |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 111 | |
| 112 | Returns: |
| 113 | An object of the form: |
| 114 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 115 | { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 116 | "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED* |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 117 | "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. |
| 118 | "kind": "A String", # This is always *sql#operationErrors*. |
| 119 | "errors": [ # The list of errors encountered while processing this operation. |
| 120 | { # Database instance operation error. |
| 121 | "code": "A String", # Identifies the specific error that occurred. |
| 122 | "message": "A String", # Additional information about the error encountered. |
| 123 | "kind": "A String", # This is always *sql#operationError*. |
| 124 | }, |
| 125 | ], |
| 126 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 127 | "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 128 | "targetLink": "A String", |
| 129 | "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 Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 130 | "exportContext": { # Database instance export context. # The context for export operation, if applicable. |
| 131 | "offload": True or False, # Option for export offload. |
| 132 | "csvExportOptions": { # Options for exporting data as CSV. |
| 133 | "selectQuery": "A String", # The select query used to extract the data. |
| 134 | }, |
| 135 | "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. |
| 136 | "A String", |
| 137 | ], |
| 138 | "kind": "A String", # This is always *sql#exportContext*. |
| 139 | "sqlExportOptions": { # Options for exporting data as SQL statements. |
| 140 | "schemaOnly": True or False, # Export only schemas. |
| 141 | "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. |
| 142 | "A String", |
| 143 | ], |
| 144 | "mysqlExportOptions": { # Options for exporting from MySQL. |
| 145 | "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored. |
| 146 | }, |
| 147 | }, |
| 148 | "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. |
| 149 | "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed. |
| 150 | }, |
| 151 | "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* |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 152 | "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 153 | "selfLink": "A String", # The URI of this resource. |
| 154 | "kind": "A String", # This is always *sql#operation*. |
| 155 | "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. |
| 156 | "targetProject": "A String", # The project ID of the target instance related to this operation. |
| 157 | "importContext": { # Database instance import context. # The context for import operation, if applicable. |
| 158 | "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. |
| 159 | "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. |
| 160 | "csvImportOptions": { # Options for importing data as CSV. |
| 161 | "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. |
| 162 | "A String", |
| 163 | ], |
| 164 | "table": "A String", # The table to which CSV data is imported. |
| 165 | }, |
| 166 | "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. |
| 167 | "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. |
| 168 | "kind": "A String", # This is always *sql#importContext*. |
| 169 | "bakImportOptions": { # Import parameters specific to SQL Server .BAK files |
| 170 | "encryptionOptions": { |
| 171 | "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. |
| 172 | "pvkPassword": "A String", # Password that encrypts the private key |
| 173 | "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. |
| 174 | }, |
| 175 | }, |
| 176 | }, |
| 177 | "user": "A String", # The email address of the user who initiated this operation. |
| 178 | "targetId": "A String", # Name of the database instance related to this operation. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 179 | }</pre> |
| 180 | </div> |
| 181 | |
| 182 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 183 | <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 184 | <pre>Creates a new user in a Cloud SQL instance. |
| 185 | |
| 186 | Args: |
| 187 | project: string, Project ID of the project that contains the instance. (required) |
| 188 | instance: string, Database instance ID. This does not include the project ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 189 | body: object, The request body. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 190 | The object takes the form of: |
| 191 | |
| 192 | { # A Cloud SQL user resource. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 193 | "password": "A String", # The password for the user. |
| 194 | "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance. |
| 195 | "serverRoles": [ # The server roles for this user |
| 196 | "A String", |
| 197 | ], |
| 198 | "disabled": True or False, # If the user has been disabled |
| 199 | }, |
| 200 | "kind": "A String", # This is always *sql#user*. |
| 201 | "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. |
| 202 | "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. |
| 203 | "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. |
| 204 | "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. |
| 205 | "etag": "A String", # This field is deprecated and will be removed from a future version of the API. |
| 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 | } |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 208 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 209 | x__xgafv: string, V1 error format. |
| 210 | Allowed values |
| 211 | 1 - v1 error format |
| 212 | 2 - v2 error format |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 213 | |
| 214 | Returns: |
| 215 | An object of the form: |
| 216 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 217 | { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 218 | "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED* |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 219 | "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. |
| 220 | "kind": "A String", # This is always *sql#operationErrors*. |
| 221 | "errors": [ # The list of errors encountered while processing this operation. |
| 222 | { # Database instance operation error. |
| 223 | "code": "A String", # Identifies the specific error that occurred. |
| 224 | "message": "A String", # Additional information about the error encountered. |
| 225 | "kind": "A String", # This is always *sql#operationError*. |
| 226 | }, |
| 227 | ], |
| 228 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 229 | "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 230 | "targetLink": "A String", |
| 231 | "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 Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 232 | "exportContext": { # Database instance export context. # The context for export operation, if applicable. |
| 233 | "offload": True or False, # Option for export offload. |
| 234 | "csvExportOptions": { # Options for exporting data as CSV. |
| 235 | "selectQuery": "A String", # The select query used to extract the data. |
| 236 | }, |
| 237 | "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. |
| 238 | "A String", |
| 239 | ], |
| 240 | "kind": "A String", # This is always *sql#exportContext*. |
| 241 | "sqlExportOptions": { # Options for exporting data as SQL statements. |
| 242 | "schemaOnly": True or False, # Export only schemas. |
| 243 | "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. |
| 244 | "A String", |
| 245 | ], |
| 246 | "mysqlExportOptions": { # Options for exporting from MySQL. |
| 247 | "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored. |
| 248 | }, |
| 249 | }, |
| 250 | "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. |
| 251 | "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed. |
| 252 | }, |
| 253 | "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* |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 254 | "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 255 | "selfLink": "A String", # The URI of this resource. |
| 256 | "kind": "A String", # This is always *sql#operation*. |
| 257 | "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. |
| 258 | "targetProject": "A String", # The project ID of the target instance related to this operation. |
| 259 | "importContext": { # Database instance import context. # The context for import operation, if applicable. |
| 260 | "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. |
| 261 | "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. |
| 262 | "csvImportOptions": { # Options for importing data as CSV. |
| 263 | "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. |
| 264 | "A String", |
| 265 | ], |
| 266 | "table": "A String", # The table to which CSV data is imported. |
| 267 | }, |
| 268 | "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. |
| 269 | "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. |
| 270 | "kind": "A String", # This is always *sql#importContext*. |
| 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 | }, |
| 279 | "user": "A String", # The email address of the user who initiated this operation. |
| 280 | "targetId": "A String", # Name of the database instance related to this operation. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 281 | }</pre> |
| 282 | </div> |
| 283 | |
| 284 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 285 | <code class="details" id="list">list(project, instance, x__xgafv=None)</code> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 286 | <pre>Lists users in the specified Cloud SQL instance. |
| 287 | |
| 288 | Args: |
| 289 | project: string, Project ID of the project that contains the instance. (required) |
| 290 | instance: string, Database instance ID. This does not include the project ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 291 | x__xgafv: string, V1 error format. |
| 292 | Allowed values |
| 293 | 1 - v1 error format |
| 294 | 2 - v2 error format |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 295 | |
| 296 | Returns: |
| 297 | An object of the form: |
| 298 | |
| 299 | { # User list response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 300 | "items": [ # List of user resources in the instance. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 301 | { # A Cloud SQL user resource. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 302 | "password": "A String", # The password for the user. |
| 303 | "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance. |
| 304 | "serverRoles": [ # The server roles for this user |
| 305 | "A String", |
| 306 | ], |
| 307 | "disabled": True or False, # If the user has been disabled |
| 308 | }, |
| 309 | "kind": "A String", # This is always *sql#user*. |
| 310 | "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. |
| 311 | "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. |
| 312 | "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. |
| 313 | "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. |
| 314 | "etag": "A String", # This field is deprecated and will be removed from a future version of the API. |
| 315 | "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. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 316 | }, |
| 317 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 318 | "kind": "A String", # This is always *sql#usersList*. |
| 319 | "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. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 320 | }</pre> |
| 321 | </div> |
| 322 | |
| 323 | <div class="method"> |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 324 | <code class="details" id="update">update(project, instance, body=None, host=None, name=None, x__xgafv=None)</code> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 325 | <pre>Updates an existing user in a Cloud SQL instance. |
| 326 | |
| 327 | Args: |
| 328 | project: string, Project ID of the project that contains the instance. (required) |
| 329 | instance: string, Database instance ID. This does not include the project ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 330 | body: object, The request body. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 331 | The object takes the form of: |
| 332 | |
| 333 | { # A Cloud SQL user resource. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 334 | "password": "A String", # The password for the user. |
| 335 | "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance. |
| 336 | "serverRoles": [ # The server roles for this user |
| 337 | "A String", |
| 338 | ], |
| 339 | "disabled": True or False, # If the user has been disabled |
| 340 | }, |
| 341 | "kind": "A String", # This is always *sql#user*. |
| 342 | "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. |
| 343 | "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. |
| 344 | "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. |
| 345 | "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. |
| 346 | "etag": "A String", # This field is deprecated and will be removed from a future version of the API. |
| 347 | "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. |
| 348 | } |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 349 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 350 | host: string, Optional. Host of the user in the instance. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 351 | name: string, Name of the user in the instance. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 352 | x__xgafv: string, V1 error format. |
| 353 | Allowed values |
| 354 | 1 - v1 error format |
| 355 | 2 - v2 error format |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 356 | |
| 357 | Returns: |
| 358 | An object of the form: |
| 359 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 360 | { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 361 | "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED* |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 362 | "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. |
| 363 | "kind": "A String", # This is always *sql#operationErrors*. |
| 364 | "errors": [ # The list of errors encountered while processing this operation. |
| 365 | { # Database instance operation error. |
| 366 | "code": "A String", # Identifies the specific error that occurred. |
| 367 | "message": "A String", # Additional information about the error encountered. |
| 368 | "kind": "A String", # This is always *sql#operationError*. |
| 369 | }, |
| 370 | ], |
| 371 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 372 | "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 373 | "targetLink": "A String", |
| 374 | "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 Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 375 | "exportContext": { # Database instance export context. # The context for export operation, if applicable. |
| 376 | "offload": True or False, # Option for export offload. |
| 377 | "csvExportOptions": { # Options for exporting data as CSV. |
| 378 | "selectQuery": "A String", # The select query used to extract the data. |
| 379 | }, |
| 380 | "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. |
| 381 | "A String", |
| 382 | ], |
| 383 | "kind": "A String", # This is always *sql#exportContext*. |
| 384 | "sqlExportOptions": { # Options for exporting data as SQL statements. |
| 385 | "schemaOnly": True or False, # Export only schemas. |
| 386 | "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. |
| 387 | "A String", |
| 388 | ], |
| 389 | "mysqlExportOptions": { # Options for exporting from MySQL. |
| 390 | "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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored. |
| 391 | }, |
| 392 | }, |
| 393 | "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. |
| 394 | "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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed. |
| 395 | }, |
| 396 | "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* |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 397 | "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 398 | "selfLink": "A String", # The URI of this resource. |
| 399 | "kind": "A String", # This is always *sql#operation*. |
| 400 | "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. |
| 401 | "targetProject": "A String", # The project ID of the target instance related to this operation. |
| 402 | "importContext": { # Database instance import context. # The context for import operation, if applicable. |
| 403 | "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. |
| 404 | "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. |
| 405 | "csvImportOptions": { # Options for importing data as CSV. |
| 406 | "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. |
| 407 | "A String", |
| 408 | ], |
| 409 | "table": "A String", # The table to which CSV data is imported. |
| 410 | }, |
| 411 | "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. |
| 412 | "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. |
| 413 | "kind": "A String", # This is always *sql#importContext*. |
| 414 | "bakImportOptions": { # Import parameters specific to SQL Server .BAK files |
| 415 | "encryptionOptions": { |
| 416 | "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. |
| 417 | "pvkPassword": "A String", # Password that encrypts the private key |
| 418 | "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. |
| 419 | }, |
| 420 | }, |
| 421 | }, |
| 422 | "user": "A String", # The email address of the user who initiated this operation. |
| 423 | "targetId": "A String", # Name of the database instance related to this operation. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 424 | }</pre> |
| 425 | </div> |
| 426 | |
| 427 | </body></html> |