Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / sqladmin_v1beta4.users.html
blob: 2f39243f86c7e582f2df5d71bb02c566c4964865 [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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]78 <code><a href="#delete">delete(project, instance, host=None, name=None, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]79<p class="firstline">Deletes a user from a Cloud SQL instance.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <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]82<p class="firstline">Creates a new user in 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="#list">list(project, instance, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]85<p class="firstline">Lists users in the specified Cloud SQL instance.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#update">update(project, instance, body=None, name=None, host=None, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]88<p class="firstline">Updates an existing user in a Cloud SQL instance.</p>
89<h3>Method Details</h3>
90<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]91 <code class="details" id="delete">delete(project, instance, host=None, name=None, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]92 <pre>Deletes a user from a Cloud SQL instance.
93
94Args:
95 project: string, Project ID of the project that contains the instance. (required)
96 instance: string, Database instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 host: string, Host of the user in the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98 name: string, Name of the user in the instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]103
104Returns:
105 An object of the form:
106
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]107 { # An Operation resource.&amp;nbsp;For successful operations that return an
108 # Operation resource, only the fields relevant to the operation are populated
109 # in the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110 &quot;targetLink&quot;: &quot;A String&quot;,
111 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
112 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
113 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
114 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
115 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
116 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
117 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
118 # populated.
119 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
120 { # Database instance operation error.
121 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
122 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
123 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]124 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]125 ],
126 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
127 },
128 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
129 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]131 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
132 # specify a database, and is overridden by any database specification in the
133 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
134 # must be specified.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
136 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
137 &quot;encryptionOptions&quot;: {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]138 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
140 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
141 # write permissions to the bucket and read access to the file.
142 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
143 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
144 # write permissions to the bucket and read access to the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 },
146 },
147 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]148 # &lt;code&gt;gs:
149 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
150 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
151 # // write permissions to the bucket and read access to the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]152 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
153 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]154 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
155 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
156 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
157 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
158 # of the database table are loaded with CSV data.
159 &quot;A String&quot;,
160 ],
161 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]162 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
164 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
165 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
166 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]167 # identifier to retrieve the Operations resource that has information about
168 # the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]169 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]170 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
171 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
172 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
173 # stored. The URI is in the form &lt;code&gt;gs:
174 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
175 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
176 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
177 # // compressed.
178 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
179 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
180 },
181 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]183 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
184 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
185 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
186 # either by using this property or by using the
187 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
188 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
189 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
190 # this database must match the one specified in the
191 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]192 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]193 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
195 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]196 # you specify tables, specify one and only one database. For PostgreSQL
197 # instances, you can specify only one table.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]198 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]199 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]200 &quot;schemaOnly&quot;: True or False, # Export only schemas.
201 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
202 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]203 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
204 # a CHANGE MASTER TO statement with the binary log coordinates.
205 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
206 # a SQL comment, and has no effect.
207 # All other values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]208 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]209 },
210 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]211 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]212 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
213 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
214 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
215 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
216 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
217 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
218 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
219 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
220 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
221 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
222 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
223 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]224 }</pre>
225</div>
226
227<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]228 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]229 <pre>Creates a new user in a Cloud SQL instance.
230
231Args:
232 project: string, Project ID of the project that contains the instance. (required)
233 instance: string, Database instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]234 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]235 The object takes the form of:
236
237{ # A Cloud SQL user resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]238 &quot;project&quot;: &quot;A String&quot;, # The project ID of the project containing the Cloud SQL database. The Google
239 # apps domain is prefixed if applicable. Can be omitted for
240 # &lt;code&gt;update&lt;/code&gt; since it is already specified on the URL.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]241 &quot;host&quot;: &quot;A String&quot;, # The host name from which the user can connect. For &lt;code&gt;insert&lt;/code&gt;
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]242 # operations, host defaults to an empty string. For &lt;code&gt;update&lt;/code&gt;
243 # operations, host is specified as part of the request URL. The host name
244 # cannot be updated after insertion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#user&lt;/code&gt;.
246 &quot;password&quot;: &quot;A String&quot;, # The password for the user.
247 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]248 # API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]249 &quot;sqlserverUserDetails&quot;: { # Represents a Sql Server user on the Cloud SQL instance.
250 &quot;disabled&quot;: True or False, # If the user has been disabled
251 &quot;serverRoles&quot;: [ # The server roles for this user
252 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]253 ],
254 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]255 &quot;name&quot;: &quot;A String&quot;, # The name of the user in the Cloud SQL instance. Can be omitted for
256 # &lt;code&gt;update&lt;/code&gt; since it is already specified in the URL.
257 &quot;instance&quot;: &quot;A String&quot;, # The name of the Cloud SQL instance. This does not include the project ID.
258 # Can be omitted for &lt;code&gt;update&lt;/code&gt; since it is already specified on the
259 # URL.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]260 }
261
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]262 x__xgafv: string, V1 error format.
263 Allowed values
264 1 - v1 error format
265 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]266
267Returns:
268 An object of the form:
269
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]270 { # An Operation resource.&amp;nbsp;For successful operations that return an
271 # Operation resource, only the fields relevant to the operation are populated
272 # in the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]273 &quot;targetLink&quot;: &quot;A String&quot;,
274 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
275 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
276 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
277 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
278 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
279 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
280 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
281 # populated.
282 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
283 { # Database instance operation error.
284 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
285 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
286 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]287 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]288 ],
289 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
290 },
291 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
292 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]293 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]294 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
295 # specify a database, and is overridden by any database specification in the
296 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
297 # must be specified.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]298 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
299 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
300 &quot;encryptionOptions&quot;: {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]301 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]302 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
303 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
304 # write permissions to the bucket and read access to the file.
305 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
306 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
307 # write permissions to the bucket and read access to the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]308 },
309 },
310 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]311 # &lt;code&gt;gs:
312 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
313 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
314 # // write permissions to the bucket and read access to the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]315 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
316 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]317 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
318 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
319 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
320 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
321 # of the database table are loaded with CSV data.
322 &quot;A String&quot;,
323 ],
324 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]325 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]326 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
327 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
328 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
329 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]330 # identifier to retrieve the Operations resource that has information about
331 # the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]332 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]333 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
334 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
335 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
336 # stored. The URI is in the form &lt;code&gt;gs:
337 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
338 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
339 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
340 # // compressed.
341 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
342 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
343 },
344 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]345 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]346 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
347 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
348 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
349 # either by using this property or by using the
350 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
351 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
352 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
353 # this database must match the one specified in the
354 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]355 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]356 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]357 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
358 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]359 # you specify tables, specify one and only one database. For PostgreSQL
360 # instances, you can specify only one table.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]361 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]362 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]363 &quot;schemaOnly&quot;: True or False, # Export only schemas.
364 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
365 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]366 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
367 # a CHANGE MASTER TO statement with the binary log coordinates.
368 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
369 # a SQL comment, and has no effect.
370 # All other values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]371 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]372 },
373 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]374 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]375 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
376 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
377 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
378 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
379 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
380 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
381 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
382 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
383 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
384 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
385 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
386 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]387 }</pre>
388</div>
389
390<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]391 <code class="details" id="list">list(project, instance, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]392 <pre>Lists users in the specified Cloud SQL instance.
393
394Args:
395 project: string, Project ID of the project that contains the instance. (required)
396 instance: string, Database instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]397 x__xgafv: string, V1 error format.
398 Allowed values
399 1 - v1 error format
400 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]401
402Returns:
403 An object of the form:
404
405 { # User list response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]406 &quot;items&quot;: [ # List of user resources in the instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]407 { # A Cloud SQL user resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]408 &quot;project&quot;: &quot;A String&quot;, # The project ID of the project containing the Cloud SQL database. The Google
409 # apps domain is prefixed if applicable. Can be omitted for
410 # &lt;code&gt;update&lt;/code&gt; since it is already specified on the URL.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]411 &quot;host&quot;: &quot;A String&quot;, # The host name from which the user can connect. For &lt;code&gt;insert&lt;/code&gt;
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]412 # operations, host defaults to an empty string. For &lt;code&gt;update&lt;/code&gt;
413 # operations, host is specified as part of the request URL. The host name
414 # cannot be updated after insertion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]415 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#user&lt;/code&gt;.
416 &quot;password&quot;: &quot;A String&quot;, # The password for the user.
417 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]418 # API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]419 &quot;sqlserverUserDetails&quot;: { # Represents a Sql Server user on the Cloud SQL instance.
420 &quot;disabled&quot;: True or False, # If the user has been disabled
421 &quot;serverRoles&quot;: [ # The server roles for this user
422 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]423 ],
424 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]425 &quot;name&quot;: &quot;A String&quot;, # The name of the user in the Cloud SQL instance. Can be omitted for
426 # &lt;code&gt;update&lt;/code&gt; since it is already specified in the URL.
427 &quot;instance&quot;: &quot;A String&quot;, # The name of the Cloud SQL instance. This does not include the project ID.
428 # Can be omitted for &lt;code&gt;update&lt;/code&gt; since it is already specified on the
429 # URL.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]430 },
431 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]432 &quot;nextPageToken&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
433 # identifier to retrieve the Operations resource that has information about
434 # the operation.
435 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#usersList&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]436 }</pre>
437</div>
438
439<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]440 <code class="details" id="update">update(project, instance, body=None, name=None, host=None, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]441 <pre>Updates an existing user in a Cloud SQL instance.
442
443Args:
444 project: string, Project ID of the project that contains the instance. (required)
445 instance: string, Database instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]446 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]447 The object takes the form of:
448
449{ # A Cloud SQL user resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]450 &quot;project&quot;: &quot;A String&quot;, # The project ID of the project containing the Cloud SQL database. The Google
451 # apps domain is prefixed if applicable. Can be omitted for
452 # &lt;code&gt;update&lt;/code&gt; since it is already specified on the URL.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]453 &quot;host&quot;: &quot;A String&quot;, # The host name from which the user can connect. For &lt;code&gt;insert&lt;/code&gt;
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]454 # operations, host defaults to an empty string. For &lt;code&gt;update&lt;/code&gt;
455 # operations, host is specified as part of the request URL. The host name
456 # cannot be updated after insertion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]457 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#user&lt;/code&gt;.
458 &quot;password&quot;: &quot;A String&quot;, # The password for the user.
459 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]460 # API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]461 &quot;sqlserverUserDetails&quot;: { # Represents a Sql Server user on the Cloud SQL instance.
462 &quot;disabled&quot;: True or False, # If the user has been disabled
463 &quot;serverRoles&quot;: [ # The server roles for this user
464 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]465 ],
466 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]467 &quot;name&quot;: &quot;A String&quot;, # The name of the user in the Cloud SQL instance. Can be omitted for
468 # &lt;code&gt;update&lt;/code&gt; since it is already specified in the URL.
469 &quot;instance&quot;: &quot;A String&quot;, # The name of the Cloud SQL instance. This does not include the project ID.
470 # Can be omitted for &lt;code&gt;update&lt;/code&gt; since it is already specified on the
471 # URL.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]472 }
473
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]474 name: string, Name of the user in the instance.
475 host: string, Optional. Host of the user in the instance.
476 x__xgafv: string, V1 error format.
477 Allowed values
478 1 - v1 error format
479 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]480
481Returns:
482 An object of the form:
483
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]484 { # An Operation resource.&amp;nbsp;For successful operations that return an
485 # Operation resource, only the fields relevant to the operation are populated
486 # in the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]487 &quot;targetLink&quot;: &quot;A String&quot;,
488 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
489 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
490 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
491 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
492 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
493 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
494 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
495 # populated.
496 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
497 { # Database instance operation error.
498 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
499 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
500 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]501 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]502 ],
503 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
504 },
505 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
506 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]507 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]508 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
509 # specify a database, and is overridden by any database specification in the
510 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
511 # must be specified.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]512 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
513 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
514 &quot;encryptionOptions&quot;: {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]515 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]516 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
517 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
518 # write permissions to the bucket and read access to the file.
519 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
520 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
521 # write permissions to the bucket and read access to the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]522 },
523 },
524 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]525 # &lt;code&gt;gs:
526 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
527 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
528 # // write permissions to the bucket and read access to the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]529 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
530 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]531 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
532 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
533 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
534 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
535 # of the database table are loaded with CSV data.
536 &quot;A String&quot;,
537 ],
538 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]539 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]540 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
541 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
542 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
543 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]544 # identifier to retrieve the Operations resource that has information about
545 # the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]546 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]547 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
548 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
549 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
550 # stored. The URI is in the form &lt;code&gt;gs:
551 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
552 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
553 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
554 # // compressed.
555 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
556 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
557 },
558 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]559 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]560 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
561 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
562 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
563 # either by using this property or by using the
564 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
565 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
566 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
567 # this database must match the one specified in the
568 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]569 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]570 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]571 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
572 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]573 # you specify tables, specify one and only one database. For PostgreSQL
574 # instances, you can specify only one table.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]575 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]576 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]577 &quot;schemaOnly&quot;: True or False, # Export only schemas.
578 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
579 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]580 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
581 # a CHANGE MASTER TO statement with the binary log coordinates.
582 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
583 # a SQL comment, and has no effect.
584 # All other values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]585 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]586 },
587 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]588 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]589 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
590 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
591 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
592 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
593 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
594 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
595 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
596 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
597 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
598 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
599 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
600 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]601 }</pre>
602</div>
603
604</body></html>