blob: 4222aa1c4abd30f783048e8c4316ab627f20e5d9 [file] [log] [blame]
yoshi-code-bota36e3b12021-07-27 00:20:26 -07001<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, body_etag=None, body_host=None, body_instance=None, body_kind=None, body_name=None, body_password=None, body_project=None, body_sqlserverUserDetails_disabled=None, body_sqlserverUserDetails_serverRoles=None, body_type=None, 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 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
117 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
118 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#backupContext**.
119 },
120 &quot;endTime&quot;: &quot;A String&quot;, # 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 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
122 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
123 { # Database instance operation error.
124 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
125 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationError**.
126 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
127 },
128 ],
129 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationErrors**.
130 },
131 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
132 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.
133 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
134 },
135 &quot;databases&quot;: [ # 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**.
136 &quot;A String&quot;,
137 ],
138 &quot;fileType&quot;: &quot;A String&quot;, # 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.
139 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#exportContext**.
140 &quot;offload&quot;: True or False, # Option for export offload.
141 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
142 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
143 &quot;masterData&quot;: 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.
144 },
145 &quot;schemaOnly&quot;: True or False, # Export only schemas.
146 &quot;tables&quot;: [ # 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.
147 &quot;A String&quot;,
148 ],
149 },
150 &quot;uri&quot;: &quot;A String&quot;, # 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.
151 },
152 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
153 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
154 &quot;encryptionOptions&quot;: {
155 &quot;certPath&quot;: &quot;A String&quot;, # 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.
156 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
157 &quot;pvkPath&quot;: &quot;A String&quot;, # 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.
158 },
159 },
160 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
161 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
162 &quot;A String&quot;,
163 ],
164 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
165 },
166 &quot;database&quot;: &quot;A String&quot;, # 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 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.
168 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
169 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#importContext**.
170 &quot;uri&quot;: &quot;A String&quot;, # 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.
171 },
172 &quot;insertTime&quot;: &quot;A String&quot;, # 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**.
173 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operation**.
174 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
175 &quot;operationType&quot;: &quot;A String&quot;, # 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**
176 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
177 &quot;startTime&quot;: &quot;A String&quot;, # 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**.
178 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**
179 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
180 &quot;targetLink&quot;: &quot;A String&quot;,
181 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
182 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
183}</pre>
184</div>
185
186<div class="method">
187 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
188 <pre>Creates a new user in a Cloud SQL instance.
189
190Args:
191 project: string, Project ID of the project that contains the instance. (required)
192 instance: string, Database instance ID. This does not include the project ID. (required)
193 body: object, The request body.
194 The object takes the form of:
195
196{ # A Cloud SQL user resource.
197 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the API.
198 &quot;host&quot;: &quot;A String&quot;, # 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.
199 &quot;instance&quot;: &quot;A String&quot;, # 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.
200 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#user*.
201 &quot;name&quot;: &quot;A String&quot;, # The name of the user in the Cloud SQL instance. Can be omitted for *update* since it is already specified in the URL.
202 &quot;password&quot;: &quot;A String&quot;, # The password for the user.
203 &quot;project&quot;: &quot;A String&quot;, # 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.
204 &quot;sqlserverUserDetails&quot;: { # Represents a Sql Server user on the Cloud SQL instance.
205 &quot;disabled&quot;: True or False, # If the user has been disabled
206 &quot;serverRoles&quot;: [ # The server roles for this user
207 &quot;A String&quot;,
208 ],
209 },
210 &quot;type&quot;: &quot;A String&quot;, # The user type. It determines the method to authenticate the user during login. The default is the database&#x27;s built-in user type.
211}
212
213 x__xgafv: string, V1 error format.
214 Allowed values
215 1 - v1 error format
216 2 - v2 error format
217
218Returns:
219 An object of the form:
220
221 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
222 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
223 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
224 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#backupContext**.
225 },
226 &quot;endTime&quot;: &quot;A String&quot;, # 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**.
227 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
228 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
229 { # Database instance operation error.
230 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
231 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationError**.
232 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
233 },
234 ],
235 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationErrors**.
236 },
237 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
238 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.
239 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
240 },
241 &quot;databases&quot;: [ # 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**.
242 &quot;A String&quot;,
243 ],
244 &quot;fileType&quot;: &quot;A String&quot;, # 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.
245 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#exportContext**.
246 &quot;offload&quot;: True or False, # Option for export offload.
247 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
248 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
249 &quot;masterData&quot;: 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.
250 },
251 &quot;schemaOnly&quot;: True or False, # Export only schemas.
252 &quot;tables&quot;: [ # 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.
253 &quot;A String&quot;,
254 ],
255 },
256 &quot;uri&quot;: &quot;A String&quot;, # 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.
257 },
258 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
259 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
260 &quot;encryptionOptions&quot;: {
261 &quot;certPath&quot;: &quot;A String&quot;, # 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.
262 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
263 &quot;pvkPath&quot;: &quot;A String&quot;, # 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.
264 },
265 },
266 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
267 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
268 &quot;A String&quot;,
269 ],
270 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
271 },
272 &quot;database&quot;: &quot;A String&quot;, # 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.
273 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.
274 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
275 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#importContext**.
276 &quot;uri&quot;: &quot;A String&quot;, # 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.
277 },
278 &quot;insertTime&quot;: &quot;A String&quot;, # 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**.
279 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operation**.
280 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
281 &quot;operationType&quot;: &quot;A String&quot;, # 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**
282 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
283 &quot;startTime&quot;: &quot;A String&quot;, # 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**.
284 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**
285 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
286 &quot;targetLink&quot;: &quot;A String&quot;,
287 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
288 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
289}</pre>
290</div>
291
292<div class="method">
293 <code class="details" id="list">list(project, instance, body_etag=None, body_host=None, body_instance=None, body_kind=None, body_name=None, body_password=None, body_project=None, body_sqlserverUserDetails_disabled=None, body_sqlserverUserDetails_serverRoles=None, body_type=None, x__xgafv=None)</code>
294 <pre>Lists users in the specified Cloud SQL instance.
295
296Args:
297 project: string, Project ID of the project that contains the instance. (required)
298 instance: string, Database instance ID. This does not include the project ID. (required)
299 body_etag: string, This field is deprecated and will be removed from a future version of the API.
300 body_host: 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.
301 body_instance: 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.
302 body_kind: string, This is always *sql#user*.
303 body_name: string, The name of the user in the Cloud SQL instance. Can be omitted for *update* since it is already specified in the URL.
304 body_password: string, The password for the user.
305 body_project: 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.
306 body_sqlserverUserDetails_disabled: boolean, If the user has been disabled
307 body_sqlserverUserDetails_serverRoles: string, The server roles for this user (repeated)
308 body_type: string, The user type. It determines the method to authenticate the user during login. The default is the database&#x27;s built-in user type.
309 Allowed values
310 BUILT_IN - The database&#x27;s built-in user type.
311 CLOUD_IAM_USER - Cloud IAM user.
312 CLOUD_IAM_SERVICE_ACCOUNT - Cloud IAM service account.
313 x__xgafv: string, V1 error format.
314 Allowed values
315 1 - v1 error format
316 2 - v2 error format
317
318Returns:
319 An object of the form:
320
321 { # User list response.
322 &quot;items&quot;: [ # List of user resources in the instance.
323 { # A Cloud SQL user resource.
324 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the API.
325 &quot;host&quot;: &quot;A String&quot;, # 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.
326 &quot;instance&quot;: &quot;A String&quot;, # 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.
327 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#user*.
328 &quot;name&quot;: &quot;A String&quot;, # The name of the user in the Cloud SQL instance. Can be omitted for *update* since it is already specified in the URL.
329 &quot;password&quot;: &quot;A String&quot;, # The password for the user.
330 &quot;project&quot;: &quot;A String&quot;, # 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.
331 &quot;sqlserverUserDetails&quot;: { # Represents a Sql Server user on the Cloud SQL instance.
332 &quot;disabled&quot;: True or False, # If the user has been disabled
333 &quot;serverRoles&quot;: [ # The server roles for this user
334 &quot;A String&quot;,
335 ],
336 },
337 &quot;type&quot;: &quot;A String&quot;, # The user type. It determines the method to authenticate the user during login. The default is the database&#x27;s built-in user type.
338 },
339 ],
340 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#usersList*.
341 &quot;nextPageToken&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
342}</pre>
343</div>
344
345<div class="method">
346 <code class="details" id="update">update(project, instance, body=None, host=None, name=None, x__xgafv=None)</code>
347 <pre>Updates an existing user in a Cloud SQL instance.
348
349Args:
350 project: string, Project ID of the project that contains the instance. (required)
351 instance: string, Database instance ID. This does not include the project ID. (required)
352 body: object, The request body.
353 The object takes the form of:
354
355{ # A Cloud SQL user resource.
356 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the API.
357 &quot;host&quot;: &quot;A String&quot;, # 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.
358 &quot;instance&quot;: &quot;A String&quot;, # 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.
359 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#user*.
360 &quot;name&quot;: &quot;A String&quot;, # The name of the user in the Cloud SQL instance. Can be omitted for *update* since it is already specified in the URL.
361 &quot;password&quot;: &quot;A String&quot;, # The password for the user.
362 &quot;project&quot;: &quot;A String&quot;, # 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.
363 &quot;sqlserverUserDetails&quot;: { # Represents a Sql Server user on the Cloud SQL instance.
364 &quot;disabled&quot;: True or False, # If the user has been disabled
365 &quot;serverRoles&quot;: [ # The server roles for this user
366 &quot;A String&quot;,
367 ],
368 },
369 &quot;type&quot;: &quot;A String&quot;, # The user type. It determines the method to authenticate the user during login. The default is the database&#x27;s built-in user type.
370}
371
372 host: string, Optional. Host of the user in the instance.
373 name: string, Name of the user in the instance.
374 x__xgafv: string, V1 error format.
375 Allowed values
376 1 - v1 error format
377 2 - v2 error format
378
379Returns:
380 An object of the form:
381
382 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
383 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
384 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
385 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#backupContext**.
386 },
387 &quot;endTime&quot;: &quot;A String&quot;, # 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**.
388 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
389 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
390 { # Database instance operation error.
391 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
392 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationError**.
393 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
394 },
395 ],
396 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationErrors**.
397 },
398 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
399 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.
400 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
401 },
402 &quot;databases&quot;: [ # 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**.
403 &quot;A String&quot;,
404 ],
405 &quot;fileType&quot;: &quot;A String&quot;, # 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.
406 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#exportContext**.
407 &quot;offload&quot;: True or False, # Option for export offload.
408 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
409 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
410 &quot;masterData&quot;: 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.
411 },
412 &quot;schemaOnly&quot;: True or False, # Export only schemas.
413 &quot;tables&quot;: [ # 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.
414 &quot;A String&quot;,
415 ],
416 },
417 &quot;uri&quot;: &quot;A String&quot;, # 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.
418 },
419 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
420 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
421 &quot;encryptionOptions&quot;: {
422 &quot;certPath&quot;: &quot;A String&quot;, # 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.
423 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
424 &quot;pvkPath&quot;: &quot;A String&quot;, # 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.
425 },
426 },
427 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
428 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
429 &quot;A String&quot;,
430 ],
431 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
432 },
433 &quot;database&quot;: &quot;A String&quot;, # 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.
434 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.
435 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
436 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#importContext**.
437 &quot;uri&quot;: &quot;A String&quot;, # 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.
438 },
439 &quot;insertTime&quot;: &quot;A String&quot;, # 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**.
440 &quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operation**.
441 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
442 &quot;operationType&quot;: &quot;A String&quot;, # 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**
443 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
444 &quot;startTime&quot;: &quot;A String&quot;, # 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**.
445 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**
446 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
447 &quot;targetLink&quot;: &quot;A String&quot;,
448 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
449 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
450}</pre>
451</div>
452
453</body></html>