blob: 62aee51031a19ca29252207778eabe58538f1c47 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="sql_v1beta4.html">Cloud SQL Admin API</a> . <a href="sql_v1beta4.backupRuns.html">backupRuns</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, instance, id, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes the backup taken by a backup run.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, instance, id, x__xgafv=None)</a></code></p>
82<p class="firstline">Retrieves a resource containing information about a backup run.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Creates a new backup run on demand. This method is applicable only to</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, instance, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists all backup runs associated with a given instance and configuration in</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(project, instance, id, x__xgafv=None)</code>
95 <pre>Deletes the backup taken by a backup run.
96
97Args:
98 project: string, Project ID of the project that contains the instance. (required)
99 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
100 id: string, The ID of the Backup Run to delete. To find a Backup Run ID, use the &lt;a
101href=&quot;/sql/docs/db_path/admin-api/rest/v1beta4/backupRuns/list&quot;&gt;list&lt;/a&gt;
102method. (required)
103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
107
108Returns:
109 An object of the form:
110
111 { # An Operation resource.&amp;nbsp;For successful operations that return an
112 # Operation resource, only the fields relevant to the operation are populated
113 # in the resource.
114 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
115 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
116 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
117 &quot;targetLink&quot;: &quot;A String&quot;,
118 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
119 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
120 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
121 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
122 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
123 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
124 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
125 # populated.
126 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
127 { # Database instance operation error.
128 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
129 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
130 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
131 },
132 ],
133 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
134 },
135 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
136 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
137 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
138 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
139 # of the database table are loaded with CSV data.
140 &quot;A String&quot;,
141 ],
142 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
143 },
144 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
145 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
146 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
147 # specify a database, and is overridden by any database specification in the
148 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
149 # must be specified.
150 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
151 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
152 &quot;encryptionOptions&quot;: {
153 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
154 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
155 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
156 # write permissions to the bucket and read access to the file.
157 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
158 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
159 # write permissions to the bucket and read access to the file.
160 },
161 },
162 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
163 # &lt;code&gt;gs:
164 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
165 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
166 # // write permissions to the bucket and read access to the file.
167 &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
168 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
169 },
170 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
171 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
172 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
173 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
174 # identifier to retrieve the Operations resource that has information about
175 # the operation.
176 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
177 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
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.
187 &quot;A String&quot;,
188 ],
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
191 # you specify tables, specify one and only one database. For PostgreSQL
192 # instances, you can specify only one table.
193 &quot;A String&quot;,
194 ],
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.
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.
203 },
204 },
205 &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
206 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
207 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
208 # stored. The URI is in the form &lt;code&gt;gs:
209 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
210 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
211 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
212 # // compressed.
213 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
214 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
215 },
216 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
217 },
218 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
219 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
220 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
221 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
222 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
223 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
224 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
225 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
226 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
227 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
228 }</pre>
229</div>
230
231<div class="method">
232 <code class="details" id="get">get(project, instance, id, x__xgafv=None)</code>
233 <pre>Retrieves a resource containing information about a backup run.
234
235Args:
236 project: string, Project ID of the project that contains the instance. (required)
237 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
238 id: string, The ID of this Backup Run. (required)
239 x__xgafv: string, V1 error format.
240 Allowed values
241 1 - v1 error format
242 2 - v2 error format
243
244Returns:
245 An object of the form:
246
247 { # A BackupRun resource.
248 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;.
249 &quot;windowStartTime&quot;: &quot;A String&quot;, # The start time of the backup window during which this the backup was
250 # attempted in &lt;a href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt;
251 # format, for example &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
252 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
253 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup.
254 # Applies only to Second Generation instances.
255 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
256 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#diskEncryptionStatus&lt;/code&gt;.
257 },
258 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#backupRun&lt;/code&gt;.
259 &quot;error&quot;: { # Database instance operation error. # Information about why the backup operation failed. This is only present if
260 # the run has the FAILED status.
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.
263 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
264 },
265 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
266 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
267 # Applies only to Second Generation instances.
268 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#diskEncryptionConfiguration&lt;/code&gt;.
269 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
270 },
271 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
272 &quot;enqueuedTime&quot;: &quot;A String&quot;, # The time the run was enqueued in UTC timezone in &lt;a
273 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
274 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
275 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL
276 # instance.
277 &quot;endTime&quot;: &quot;A String&quot;, # The time the backup operation completed in UTC timezone in &lt;a
278 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
279 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
280 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
281 &quot;startTime&quot;: &quot;A String&quot;, # The time the backup operation actually started in UTC timezone in &lt;a
282 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
283 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
284 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
285 }</pre>
286</div>
287
288<div class="method">
289 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
290 <pre>Creates a new backup run on demand. This method is applicable only to
291Second Generation instances.
292
293Args:
294 project: string, Project ID of the project that contains the instance. (required)
295 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
296 body: object, The request body.
297 The object takes the form of:
298
299{ # A BackupRun resource.
300 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;.
301 &quot;windowStartTime&quot;: &quot;A String&quot;, # The start time of the backup window during which this the backup was
302 # attempted in &lt;a href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt;
303 # format, for example &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
304 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
305 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup.
306 # Applies only to Second Generation instances.
307 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
308 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#diskEncryptionStatus&lt;/code&gt;.
309 },
310 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#backupRun&lt;/code&gt;.
311 &quot;error&quot;: { # Database instance operation error. # Information about why the backup operation failed. This is only present if
312 # the run has the FAILED status.
313 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
314 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
315 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
316 },
317 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
318 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
319 # Applies only to Second Generation instances.
320 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#diskEncryptionConfiguration&lt;/code&gt;.
321 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
322 },
323 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
324 &quot;enqueuedTime&quot;: &quot;A String&quot;, # The time the run was enqueued in UTC timezone in &lt;a
325 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
326 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
327 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL
328 # instance.
329 &quot;endTime&quot;: &quot;A String&quot;, # The time the backup operation completed in UTC timezone in &lt;a
330 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
331 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
332 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
333 &quot;startTime&quot;: &quot;A String&quot;, # The time the backup operation actually started in UTC timezone in &lt;a
334 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
335 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
336 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
337 }
338
339 x__xgafv: string, V1 error format.
340 Allowed values
341 1 - v1 error format
342 2 - v2 error format
343
344Returns:
345 An object of the form:
346
347 { # An Operation resource.&amp;nbsp;For successful operations that return an
348 # Operation resource, only the fields relevant to the operation are populated
349 # in the resource.
350 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
351 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
352 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
353 &quot;targetLink&quot;: &quot;A String&quot;,
354 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
355 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
356 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
357 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
358 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
359 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
360 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
361 # populated.
362 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
363 { # Database instance operation error.
364 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
365 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
366 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
367 },
368 ],
369 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
370 },
371 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
372 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
373 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
374 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
375 # of the database table are loaded with CSV data.
376 &quot;A String&quot;,
377 ],
378 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
379 },
380 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
381 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
382 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
383 # specify a database, and is overridden by any database specification in the
384 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
385 # must be specified.
386 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
387 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
388 &quot;encryptionOptions&quot;: {
389 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
390 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
391 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
392 # write permissions to the bucket and read access to the file.
393 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
394 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
395 # write permissions to the bucket and read access to the file.
396 },
397 },
398 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
399 # &lt;code&gt;gs:
400 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
401 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
402 # // write permissions to the bucket and read access to the file.
403 &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
404 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
405 },
406 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
407 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
408 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
409 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
410 # identifier to retrieve the Operations resource that has information about
411 # the operation.
412 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
413 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
414 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
415 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
416 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
417 # either by using this property or by using the
418 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
419 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
420 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
421 # this database must match the one specified in the
422 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
423 &quot;A String&quot;,
424 ],
425 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
426 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
427 # you specify tables, specify one and only one database. For PostgreSQL
428 # instances, you can specify only one table.
429 &quot;A String&quot;,
430 ],
431 &quot;schemaOnly&quot;: True or False, # Export only schemas.
432 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
433 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
434 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
435 # a CHANGE MASTER TO statement with the binary log coordinates.
436 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
437 # a SQL comment, and has no effect.
438 # All other values are ignored.
439 },
440 },
441 &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
442 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
443 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
444 # stored. The URI is in the form &lt;code&gt;gs:
445 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
446 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
447 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
448 # // compressed.
449 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
450 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
451 },
452 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
453 },
454 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
455 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
456 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
457 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
458 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
459 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
460 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
461 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
462 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
463 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
464 }</pre>
465</div>
466
467<div class="method">
468 <code class="details" id="list">list(project, instance, pageToken=None, maxResults=None, x__xgafv=None)</code>
469 <pre>Lists all backup runs associated with a given instance and configuration in
470the reverse chronological order of the backup initiation time.
471
472Args:
473 project: string, Project ID of the project that contains the instance. (required)
474 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
475 pageToken: string, A previously-returned page token representing part of the larger set of
476results to view.
477 maxResults: integer, Maximum number of backup runs per response.
478 x__xgafv: string, V1 error format.
479 Allowed values
480 1 - v1 error format
481 2 - v2 error format
482
483Returns:
484 An object of the form:
485
486 { # Backup run list results.
487 &quot;nextPageToken&quot;: &quot;A String&quot;, # The continuation token, used to page through large result sets. Provide
488 # this value in a subsequent request to return the next page of results.
489 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#backupRunsList&lt;/code&gt;.
490 &quot;items&quot;: [ # A list of backup runs in reverse chronological order of the enqueued time.
491 { # A BackupRun resource.
492 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;.
493 &quot;windowStartTime&quot;: &quot;A String&quot;, # The start time of the backup window during which this the backup was
494 # attempted in &lt;a href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt;
495 # format, for example &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
496 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
497 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup.
498 # Applies only to Second Generation instances.
499 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
500 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#diskEncryptionStatus&lt;/code&gt;.
501 },
502 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#backupRun&lt;/code&gt;.
503 &quot;error&quot;: { # Database instance operation error. # Information about why the backup operation failed. This is only present if
504 # the run has the FAILED status.
505 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
506 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
507 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
508 },
509 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
510 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
511 # Applies only to Second Generation instances.
512 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#diskEncryptionConfiguration&lt;/code&gt;.
513 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
514 },
515 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
516 &quot;enqueuedTime&quot;: &quot;A String&quot;, # The time the run was enqueued in UTC timezone in &lt;a
517 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
518 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
519 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL
520 # instance.
521 &quot;endTime&quot;: &quot;A String&quot;, # The time the backup operation completed in UTC timezone in &lt;a
522 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
523 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
524 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
525 &quot;startTime&quot;: &quot;A String&quot;, # The time the backup operation actually started in UTC timezone in &lt;a
526 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
527 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
528 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
529 },
530 ],
531 }</pre>
532</div>
533
534<div class="method">
535 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
536 <pre>Retrieves the next page of results.
537
538Args:
539 previous_request: The request for the previous page. (required)
540 previous_response: The response from the request for the previous page. (required)
541
542Returns:
543 A request object that you can call &#x27;execute()&#x27; on to request the next
544 page. Returns None if there are no more items in the collection.
545 </pre>
546</div>
547
548</body></html>