1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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"> 87 <code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p> 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 102Args: 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 112Returns: 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. 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. 137 "selectQuery": "A String", # The select query used to extract the data. 138 }, 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**. 140 "A String", 141 ], 142 "fileType": "A String", # The file type for the specified uri. 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. 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. 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 ], 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. 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. 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** 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**. 186 "status": "A String", # The status of an operation. 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 198Args: 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. 206 "host": "A String", # Optional. 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. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional. 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. 210 "password": "A String", # The password for the user. 211 "passwordPolicy": { # User level password validation policy. # User level password validation policy. 212 "allowedFailedAttempts": 42, # Number of failed login attempts allowed before user get locked. 213 "enableFailedAttemptsCheck": True or False, # If true, failed login attempts check will be enabled. 214 "passwordExpirationDuration": "A String", # Expiration duration after password is updated. 215 "status": { # Read-only password status. # Output only. Read-only password status. 216 "locked": True or False, # If true, user does not have login privileges. 217 "passwordExpirationTime": "A String", # The expiration time of the current password. 218 }, 219 }, 220 "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. 221 "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance. 222 "disabled": True or False, # If the user has been disabled 223 "serverRoles": [ # The server roles for this user 224 "A String", 225 ], 226 }, 227 "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. 228} 229 230 x__xgafv: string, V1 error format. 231 Allowed values 232 1 - v1 error format 233 2 - v2 error format 234 235Returns: 236 An object of the form: 237 238 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 239 "backupContext": { # Backup context. # The context for backup operation, if applicable. 240 "backupId": "A String", # The identifier of the backup. 241 "kind": "A String", # This is always **sql#backupContext**. 242 }, 243 "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**. 244 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 245 "errors": [ # The list of errors encountered while processing this operation. 246 { # Database instance operation error. 247 "code": "A String", # Identifies the specific error that occurred. 248 "kind": "A String", # This is always **sql#operationError**. 249 "message": "A String", # Additional information about the error encountered. 250 }, 251 ], 252 "kind": "A String", # This is always **sql#operationErrors**. 253 }, 254 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 255 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 256 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 257 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 258 "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. 259 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 260 "selectQuery": "A String", # The select query used to extract the data. 261 }, 262 "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**. 263 "A String", 264 ], 265 "fileType": "A String", # The file type for the specified uri. 266 "kind": "A String", # This is always **sql#exportContext**. 267 "offload": True or False, # Option for export offload. 268 "sqlExportOptions": { # Options for exporting data as SQL statements. 269 "mysqlExportOptions": { # Options for exporting from MySQL. 270 "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. 271 }, 272 "schemaOnly": True or False, # Export only schemas. 273 "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. 274 "A String", 275 ], 276 }, 277 "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. 278 }, 279 "importContext": { # Database instance import context. # The context for import operation, if applicable. 280 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 281 "encryptionOptions": { 282 "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. 283 "pvkPassword": "A String", # Password that encrypts the private key 284 "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. 285 }, 286 }, 287 "csvImportOptions": { # Options for importing data as CSV. 288 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 289 "A String", 290 ], 291 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 292 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 293 "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. 294 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 295 "table": "A String", # The table to which CSV data is imported. 296 }, 297 "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. 298 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 299 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 300 "kind": "A String", # This is always **sql#importContext**. 301 "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. 302 }, 303 "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**. 304 "kind": "A String", # This is always **sql#operation**. 305 "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. 306 "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** 307 "selfLink": "A String", # The URI of this resource. 308 "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**. 309 "status": "A String", # The status of an operation. 310 "targetId": "A String", # Name of the database instance related to this operation. 311 "targetLink": "A String", 312 "targetProject": "A String", # The project ID of the target instance related to this operation. 313 "user": "A String", # The email address of the user who initiated this operation. 314}</pre> 315</div> 316 317<div class="method"> 318 <code class="details" id="list">list(project, instance, x__xgafv=None)</code> 319 <pre>Lists users in the specified Cloud SQL instance. 320 321Args: 322 project: string, Project ID of the project that contains the instance. (required) 323 instance: string, Database instance ID. This does not include the project ID. (required) 324 x__xgafv: string, V1 error format. 325 Allowed values 326 1 - v1 error format 327 2 - v2 error format 328 329Returns: 330 An object of the form: 331 332 { # User list response. 333 "items": [ # List of user resources in the instance. 334 { # A Cloud SQL user resource. 335 "etag": "A String", # This field is deprecated and will be removed from a future version of the API. 336 "host": "A String", # Optional. 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. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional. 337 "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. 338 "kind": "A String", # This is always **sql#user**. 339 "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. 340 "password": "A String", # The password for the user. 341 "passwordPolicy": { # User level password validation policy. # User level password validation policy. 342 "allowedFailedAttempts": 42, # Number of failed login attempts allowed before user get locked. 343 "enableFailedAttemptsCheck": True or False, # If true, failed login attempts check will be enabled. 344 "passwordExpirationDuration": "A String", # Expiration duration after password is updated. 345 "status": { # Read-only password status. # Output only. Read-only password status. 346 "locked": True or False, # If true, user does not have login privileges. 347 "passwordExpirationTime": "A String", # The expiration time of the current password. 348 }, 349 }, 350 "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. 351 "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance. 352 "disabled": True or False, # If the user has been disabled 353 "serverRoles": [ # The server roles for this user 354 "A String", 355 ], 356 }, 357 "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. 358 }, 359 ], 360 "kind": "A String", # This is always **sql#usersList**. 361 "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. 362}</pre> 363</div> 364 365<div class="method"> 366 <code class="details" id="update">update(project, instance, body=None, host=None, name=None, x__xgafv=None)</code> 367 <pre>Updates an existing user in a Cloud SQL instance. 368 369Args: 370 project: string, Project ID of the project that contains the instance. (required) 371 instance: string, Database instance ID. This does not include the project ID. (required) 372 body: object, The request body. 373 The object takes the form of: 374 375{ # A Cloud SQL user resource. 376 "etag": "A String", # This field is deprecated and will be removed from a future version of the API. 377 "host": "A String", # Optional. 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. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional. 378 "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. 379 "kind": "A String", # This is always **sql#user**. 380 "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. 381 "password": "A String", # The password for the user. 382 "passwordPolicy": { # User level password validation policy. # User level password validation policy. 383 "allowedFailedAttempts": 42, # Number of failed login attempts allowed before user get locked. 384 "enableFailedAttemptsCheck": True or False, # If true, failed login attempts check will be enabled. 385 "passwordExpirationDuration": "A String", # Expiration duration after password is updated. 386 "status": { # Read-only password status. # Output only. Read-only password status. 387 "locked": True or False, # If true, user does not have login privileges. 388 "passwordExpirationTime": "A String", # The expiration time of the current password. 389 }, 390 }, 391 "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. 392 "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance. 393 "disabled": True or False, # If the user has been disabled 394 "serverRoles": [ # The server roles for this user 395 "A String", 396 ], 397 }, 398 "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. 399} 400 401 host: string, Optional. Host of the user in the instance. 402 name: string, Name of the user in the instance. 403 x__xgafv: string, V1 error format. 404 Allowed values 405 1 - v1 error format 406 2 - v2 error format 407 408Returns: 409 An object of the form: 410 411 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 412 "backupContext": { # Backup context. # The context for backup operation, if applicable. 413 "backupId": "A String", # The identifier of the backup. 414 "kind": "A String", # This is always **sql#backupContext**. 415 }, 416 "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**. 417 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 418 "errors": [ # The list of errors encountered while processing this operation. 419 { # Database instance operation error. 420 "code": "A String", # Identifies the specific error that occurred. 421 "kind": "A String", # This is always **sql#operationError**. 422 "message": "A String", # Additional information about the error encountered. 423 }, 424 ], 425 "kind": "A String", # This is always **sql#operationErrors**. 426 }, 427 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 428 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 429 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 430 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 431 "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. 432 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 433 "selectQuery": "A String", # The select query used to extract the data. 434 }, 435 "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**. 436 "A String", 437 ], 438 "fileType": "A String", # The file type for the specified uri. 439 "kind": "A String", # This is always **sql#exportContext**. 440 "offload": True or False, # Option for export offload. 441 "sqlExportOptions": { # Options for exporting data as SQL statements. 442 "mysqlExportOptions": { # Options for exporting from MySQL. 443 "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. 444 }, 445 "schemaOnly": True or False, # Export only schemas. 446 "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. 447 "A String", 448 ], 449 }, 450 "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. 451 }, 452 "importContext": { # Database instance import context. # The context for import operation, if applicable. 453 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 454 "encryptionOptions": { 455 "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. 456 "pvkPassword": "A String", # Password that encrypts the private key 457 "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. 458 }, 459 }, 460 "csvImportOptions": { # Options for importing data as CSV. 461 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 462 "A String", 463 ], 464 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 465 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 466 "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. 467 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 468 "table": "A String", # The table to which CSV data is imported. 469 }, 470 "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. 471 "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. 472 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 473 "kind": "A String", # This is always **sql#importContext**. 474 "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. 475 }, 476 "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**. 477 "kind": "A String", # This is always **sql#operation**. 478 "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. 479 "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** 480 "selfLink": "A String", # The URI of this resource. 481 "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**. 482 "status": "A String", # The status of an operation. 483 "targetId": "A String", # Name of the database instance related to this operation. 484 "targetLink": "A String", 485 "targetProject": "A String", # The project ID of the target instance related to this operation. 486 "user": "A String", # The email address of the user who initiated this operation. 487}</pre> 488</div> 489 490</body></html>