Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c482712935d1c1331e33bd7f9968bd3b2be223bb / . / docs / dyn / sqladmin_v1beta4.operations.html
blob: 2b17a17711b093e583e741a055a67e3f7e17fe56 [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.operations.html">operations</a></h1>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#get">get(project, operation, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]79<p class="firstline">Retrieves an instance operation that has been performed on an instance.</p>
80<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]81 <code><a href="#list">list(project, maxResults=None, instance=None, pageToken=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]82<p class="firstline">Lists all instance operations that have been performed on the given Cloud</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]88 <code class="details" id="get">get(project, operation, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]89 <pre>Retrieves an instance operation that has been performed on an instance.
90
91Args:
92 project: string, Project ID of the project that contains the instance. (required)
93 operation: string, Instance operation ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]94 x__xgafv: string, V1 error format.
95 Allowed values
96 1 - v1 error format
97 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]98
99Returns:
100 An object of the form:
101
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 { # An Operation resource.&amp;nbsp;For successful operations that return an
103 # Operation resource, only the fields relevant to the operation are populated
104 # in the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 &quot;targetLink&quot;: &quot;A String&quot;,
106 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
107 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
108 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
109 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
110 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
111 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
112 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
113 # populated.
114 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
115 { # Database instance operation error.
116 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
117 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
118 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]119 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 ],
121 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
122 },
123 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
124 &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]125 &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]126 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
127 # specify a database, and is overridden by any database specification in the
128 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
129 # must be specified.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
131 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
132 &quot;encryptionOptions&quot;: {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]133 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]134 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
135 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
136 # write permissions to the bucket and read access to the file.
137 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
138 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
139 # write permissions to the bucket and read access to the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 },
141 },
142 &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]143 # &lt;code&gt;gs:
144 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
145 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
146 # // write permissions to the bucket and read access to the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 &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
148 # 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]149 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
150 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
151 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
152 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
153 # of the database table are loaded with CSV data.
154 &quot;A String&quot;,
155 ],
156 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]157 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]158 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
159 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
160 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
161 &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]162 # identifier to retrieve the Operations resource that has information about
163 # the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]164 &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]165 &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
166 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
167 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
168 # stored. The URI is in the form &lt;code&gt;gs:
169 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
170 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
171 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
172 # // compressed.
173 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
174 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
175 },
176 &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]177 &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]178 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
179 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
180 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
181 # either by using this property or by using the
182 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
183 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
184 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
185 # this database must match the one specified in the
186 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]188 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]189 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
190 &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]191 # you specify tables, specify one and only one database. For PostgreSQL
192 # instances, you can specify only one table.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]193 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]194 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]195 &quot;schemaOnly&quot;: True or False, # Export only schemas.
196 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
197 &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]198 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
199 # a CHANGE MASTER TO statement with the binary log coordinates.
200 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
201 # a SQL comment, and has no effect.
202 # All other values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]203 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]204 },
205 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206 &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]207 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
208 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
209 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
210 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
211 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
212 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
213 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
214 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
215 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
216 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
217 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
218 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]219 }</pre>
220</div>
221
222<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]223 <code class="details" id="list">list(project, maxResults=None, instance=None, pageToken=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]224 <pre>Lists all instance operations that have been performed on the given Cloud
225SQL instance in the reverse chronological order of the start time.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]226
227Args:
228 project: string, Project ID of the project that contains the instance. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]229 maxResults: integer, Maximum number of operations per response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]230 instance: string, Cloud SQL instance ID. This does not include the project ID.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]231 pageToken: string, A previously-returned page token representing part of the larger set of
232results to view.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]233 x__xgafv: string, V1 error format.
234 Allowed values
235 1 - v1 error format
236 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]237
238Returns:
239 An object of the form:
240
241 { # Database instance list operations response.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]242 &quot;nextPageToken&quot;: &quot;A String&quot;, # The continuation token, used to page through large result sets. Provide
243 # this value in a subsequent request to return the next page of results.
244 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationsList&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245 &quot;items&quot;: [ # List of operation resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]246 { # An Operation resource.&amp;nbsp;For successful operations that return an
247 # Operation resource, only the fields relevant to the operation are populated
248 # in the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]249 &quot;targetLink&quot;: &quot;A String&quot;,
250 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
251 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
252 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
253 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
254 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
255 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
256 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
257 # populated.
258 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
259 { # Database instance operation error.
260 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
261 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
262 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]263 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]264 ],
265 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
266 },
267 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
268 &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]269 &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]270 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
271 # specify a database, and is overridden by any database specification in the
272 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
273 # must be specified.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]274 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
275 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
276 &quot;encryptionOptions&quot;: {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]277 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]278 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
279 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
280 # write permissions to the bucket and read access to the file.
281 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
282 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
283 # write permissions to the bucket and read access to the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]284 },
285 },
286 &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]287 # &lt;code&gt;gs:
288 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
289 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
290 # // write permissions to the bucket and read access to the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]291 &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
292 # 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]293 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
294 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
295 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
296 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
297 # of the database table are loaded with CSV data.
298 &quot;A String&quot;,
299 ],
300 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]301 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]302 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
303 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
304 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
305 &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]306 # identifier to retrieve the Operations resource that has information about
307 # the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]308 &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]309 &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
310 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
311 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
312 # stored. The URI is in the form &lt;code&gt;gs:
313 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
314 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
315 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
316 # // compressed.
317 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
318 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
319 },
320 &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]321 &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]322 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
323 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
324 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
325 # either by using this property or by using the
326 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
327 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
328 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
329 # this database must match the one specified in the
330 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]331 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]332 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]333 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
334 &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]335 # you specify tables, specify one and only one database. For PostgreSQL
336 # instances, you can specify only one table.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]337 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]338 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]339 &quot;schemaOnly&quot;: True or False, # Export only schemas.
340 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
341 &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]342 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
343 # a CHANGE MASTER TO statement with the binary log coordinates.
344 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
345 # a SQL comment, and has no effect.
346 # All other values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]347 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]348 },
349 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]350 &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]351 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
352 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
353 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
354 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
355 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
356 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
357 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
358 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
359 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
360 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
361 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
362 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]363 },
364 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]365 }</pre>
366</div>
367
368<div class="method">
369 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
370 <pre>Retrieves the next page of results.
371
372Args:
373 previous_request: The request for the previous page. (required)
374 previous_response: The response from the request for the previous page. (required)
375
376Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]377 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]378 page. Returns None if there are no more items in the collection.
379 </pre>
380</div>
381
382</body></html>