Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / sqladmin_v1beta4.users.html
blob: cc4f5f868a5719b742dca8c54185f535eae56fee [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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
Bu Sun Kim715bd7f2019-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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-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">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]81 <code><a href="#delete">delete(project, instance, name=None, host=None, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-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'Mearadd494642020-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 Citroe633be12015-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'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-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 Botc2228be2020-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 Citroe633be12015-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 Frenkel3e17f892020-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">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]99 <code class="details" id="delete">delete(project, instance, name=None, host=None, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]105 name: string, Name of the user in the instance.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]106 host: string, Host of the user in the instance.
Dan O'Mearadd494642020-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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]111
112Returns:
113 An object of the form:
114
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[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. Next field: 18
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]116 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]117 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]118 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]119 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
120 &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.
121 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]122 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
123 &quot;encryptionOptions&quot;: {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]124 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]125 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
126 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]127 },
128 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]129 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]130 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]131 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
132 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
133 &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.
134 &quot;A String&quot;,
135 ],
136 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]137 },
138 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
139 &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*
140 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
141 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
142 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
143 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
144 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
145 { # Database instance operation error.
146 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
147 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
148 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
149 },
150 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]151 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]152 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]153 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
154 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]155 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]156 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]157 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]158 &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.
159 &quot;A String&quot;,
160 ],
161 &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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]162 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
163 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
164 },
165 &quot;offload&quot;: True or False, # Option for export offload.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]166 &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.
167 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
168 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
169 &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.
170 &quot;A String&quot;,
171 ],
172 &quot;schemaOnly&quot;: True or False, # Export only schemas.
173 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
174 &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.
175 },
176 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]177 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]178 &quot;targetLink&quot;: &quot;A String&quot;,
179 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
180 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupContext*.
181 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
182 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]183 }</pre>
184</div>
185
186<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]187 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]193 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]194 The object takes the form of:
195
196{ # A Cloud SQL user resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]197 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#user*.
198 &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.
199 &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.
200 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the API.
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;sqlserverUserDetails&quot;: { # Represents a Sql Server user on the Cloud SQL instance.
203 &quot;disabled&quot;: True or False, # If the user has been disabled
204 &quot;serverRoles&quot;: [ # The server roles for this user
205 &quot;A String&quot;,
206 ],
207 },
208 &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.
209 &quot;password&quot;: &quot;A String&quot;, # The password for the user.
210 &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.
211 }
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]212
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]213 x__xgafv: string, V1 error format.
214 Allowed values
215 1 - v1 error format
216 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]217
218Returns:
219 An object of the form:
220
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]221 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]222 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]223 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]224 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]225 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
226 &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.
227 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]228 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
229 &quot;encryptionOptions&quot;: {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]230 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]231 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
232 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]233 },
234 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]235 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]236 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]237 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
238 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
239 &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.
240 &quot;A String&quot;,
241 ],
242 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]243 },
244 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
245 &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*
246 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
247 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
248 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
249 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
250 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
251 { # Database instance operation error.
252 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
253 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
254 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
255 },
256 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]257 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]258 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]259 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
260 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]261 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]262 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]263 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]264 &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.
265 &quot;A String&quot;,
266 ],
267 &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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]268 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
269 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
270 },
271 &quot;offload&quot;: True or False, # Option for export offload.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]272 &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.
273 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
274 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
275 &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.
276 &quot;A String&quot;,
277 ],
278 &quot;schemaOnly&quot;: True or False, # Export only schemas.
279 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
280 &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.
281 },
282 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]283 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]284 &quot;targetLink&quot;: &quot;A String&quot;,
285 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
286 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupContext*.
287 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
288 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]289 }</pre>
290</div>
291
292<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]293 <code class="details" id="list">list(project, instance, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]299 x__xgafv: string, V1 error format.
300 Allowed values
301 1 - v1 error format
302 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]303
304Returns:
305 An object of the form:
306
307 { # User list response.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]308 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]309 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#usersList*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]310 &quot;items&quot;: [ # List of user resources in the instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]311 { # A Cloud SQL user resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]312 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#user*.
313 &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.
314 &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.
315 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the API.
316 &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.
317 &quot;sqlserverUserDetails&quot;: { # Represents a Sql Server user on the Cloud SQL instance.
318 &quot;disabled&quot;: True or False, # If the user has been disabled
319 &quot;serverRoles&quot;: [ # The server roles for this user
320 &quot;A String&quot;,
321 ],
322 },
323 &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.
324 &quot;password&quot;: &quot;A String&quot;, # The password for the user.
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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]326 },
327 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]328 }</pre>
329</div>
330
331<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]332 <code class="details" id="update">update(project, instance, body=None, host=None, name=None, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]333 <pre>Updates an existing user in a Cloud SQL instance.
334
335Args:
336 project: string, Project ID of the project that contains the instance. (required)
337 instance: string, Database instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]338 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]339 The object takes the form of:
340
341{ # A Cloud SQL user resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]342 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#user*.
343 &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.
344 &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.
345 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the API.
346 &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.
347 &quot;sqlserverUserDetails&quot;: { # Represents a Sql Server user on the Cloud SQL instance.
348 &quot;disabled&quot;: True or False, # If the user has been disabled
349 &quot;serverRoles&quot;: [ # The server roles for this user
350 &quot;A String&quot;,
351 ],
352 },
353 &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.
354 &quot;password&quot;: &quot;A String&quot;, # The password for the user.
355 &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.
356 }
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]357
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]358 host: string, Optional. Host of the user in the instance.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]359 name: string, Name of the user in the instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]360 x__xgafv: string, V1 error format.
361 Allowed values
362 1 - v1 error format
363 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]364
365Returns:
366 An object of the form:
367
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]368 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]369 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]370 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]371 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]372 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
373 &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.
374 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]375 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
376 &quot;encryptionOptions&quot;: {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]377 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]378 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
379 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]380 },
381 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]382 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]383 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]384 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
385 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
386 &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.
387 &quot;A String&quot;,
388 ],
389 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]390 },
391 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
392 &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*
393 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
394 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
395 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
396 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
397 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
398 { # Database instance operation error.
399 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
400 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
401 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
402 },
403 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]404 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]405 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]406 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
407 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]408 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]409 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]410 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]411 &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.
412 &quot;A String&quot;,
413 ],
414 &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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]415 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
416 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
417 },
418 &quot;offload&quot;: True or False, # Option for export offload.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]419 &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.
420 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
421 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
422 &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.
423 &quot;A String&quot;,
424 ],
425 &quot;schemaOnly&quot;: True or False, # Export only schemas.
426 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
427 &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.
428 },
429 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]430 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]431 &quot;targetLink&quot;: &quot;A String&quot;,
432 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
433 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupContext*.
434 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
435 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]436 }</pre>
437</div>
438
439</body></html>