Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f3348f98bf91a88a28bf61b12b95e391cc3be1ff / . / docs / dyn / sql_v1beta4.backupRuns.html
blob: 3e4a7d54fc1dc66d95fbae5007cb2fffbfc4204c [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[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
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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]87 <code><a href="#list">list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]114 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
115 # identifier to retrieve the Operations resource that has information about
116 # the operation.
117 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
118 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
119 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
120 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
121 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
122 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
123 # either by using this property or by using the
124 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
125 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
126 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
127 # this database must match the one specified in the
128 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
129 &quot;A String&quot;,
130 ],
131 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
132 &quot;schemaOnly&quot;: True or False, # Export only schemas.
133 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
134 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
135 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
136 # a CHANGE MASTER TO statement with the binary log coordinates.
137 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
138 # a SQL comment, and has no effect.
139 # All other values are ignored.
140 },
141 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
142 # you specify tables, specify one and only one database. For PostgreSQL
143 # instances, you can specify only one table.
144 &quot;A String&quot;,
145 ],
146 },
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.
149 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
150 # stored. The URI is in the form &lt;code&gt;gs:
151 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
152 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
153 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
154 # // compressed.
155 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
156 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
157 },
158 },
159 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
160 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
161 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
162 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
163 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
164 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
165 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
166 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
167 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
168 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]169 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
170 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
171 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
172 &quot;targetLink&quot;: &quot;A String&quot;,
173 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
174 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
175 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
176 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
177 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
178 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
179 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
180 # populated.
181 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
182 { # Database instance operation error.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]183 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
185 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]186 },
187 ],
188 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
189 },
190 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
191 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]192 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]193 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
194 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
195 # of the database table are loaded with CSV data.
196 &quot;A String&quot;,
197 ],
198 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
199 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]200 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
201 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
202 # specify a database, and is overridden by any database specification in the
203 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
204 # must be specified.
205 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
206 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
207 &quot;encryptionOptions&quot;: {
208 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
209 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
210 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
211 # write permissions to the bucket and read access to the file.
212 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
213 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
214 # write permissions to the bucket and read access to the file.
215 },
216 },
217 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
218 # &lt;code&gt;gs:
219 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
220 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
221 # // write permissions to the bucket and read access to the file.
222 &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
223 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
224 },
225 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
226 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
227 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]248 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]249 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;.
250 &quot;windowStartTime&quot;: &quot;A String&quot;, # The start time of the backup window during which this the backup was
251 # attempted in &lt;a href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt;
252 # format, for example &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
253 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
254 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup.
255 # Applies only to Second Generation instances.
256 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
257 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#diskEncryptionStatus&lt;/code&gt;.
258 },
259 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#backupRun&lt;/code&gt;.
260 &quot;error&quot;: { # Database instance operation error. # Information about why the backup operation failed. This is only present if
261 # the run has the FAILED status.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]262 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]263 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
264 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]265 },
266 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
267 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
268 # Applies only to Second Generation instances.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]269 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]270 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#diskEncryptionConfiguration&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]271 },
272 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
273 &quot;enqueuedTime&quot;: &quot;A String&quot;, # The time the run was enqueued in UTC timezone in &lt;a
274 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
275 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
276 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL
277 # instance.
278 &quot;endTime&quot;: &quot;A String&quot;, # The time the backup operation completed in UTC timezone in &lt;a
279 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
280 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
281 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
282 &quot;startTime&quot;: &quot;A String&quot;, # The time the backup operation actually started in UTC timezone in &lt;a
283 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
284 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]300 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]301 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;.
302 &quot;windowStartTime&quot;: &quot;A String&quot;, # The start time of the backup window during which this the backup was
303 # attempted in &lt;a href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt;
304 # format, for example &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
305 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
306 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup.
307 # Applies only to Second Generation instances.
308 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
309 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#diskEncryptionStatus&lt;/code&gt;.
310 },
311 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#backupRun&lt;/code&gt;.
312 &quot;error&quot;: { # Database instance operation error. # Information about why the backup operation failed. This is only present if
313 # the run has the FAILED status.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]314 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]315 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
316 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]317 },
318 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
319 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
320 # Applies only to Second Generation instances.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]321 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]322 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#diskEncryptionConfiguration&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]323 },
324 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
325 &quot;enqueuedTime&quot;: &quot;A String&quot;, # The time the run was enqueued in UTC timezone in &lt;a
326 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
327 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
328 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL
329 # instance.
330 &quot;endTime&quot;: &quot;A String&quot;, # The time the backup operation completed in UTC timezone in &lt;a
331 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
332 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
333 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
334 &quot;startTime&quot;: &quot;A String&quot;, # The time the backup operation actually started in UTC timezone in &lt;a
335 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
336 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]350 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
351 # identifier to retrieve the Operations resource that has information about
352 # the operation.
353 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
354 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
355 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
356 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
357 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
358 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
359 # either by using this property or by using the
360 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
361 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
362 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
363 # this database must match the one specified in the
364 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
365 &quot;A String&quot;,
366 ],
367 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
368 &quot;schemaOnly&quot;: True or False, # Export only schemas.
369 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
370 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
371 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
372 # a CHANGE MASTER TO statement with the binary log coordinates.
373 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
374 # a SQL comment, and has no effect.
375 # All other values are ignored.
376 },
377 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
378 # you specify tables, specify one and only one database. For PostgreSQL
379 # instances, you can specify only one table.
380 &quot;A String&quot;,
381 ],
382 },
383 &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
384 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
385 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
386 # stored. The URI is in the form &lt;code&gt;gs:
387 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
388 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
389 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
390 # // compressed.
391 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
392 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
393 },
394 },
395 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
396 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
397 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
398 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
399 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
400 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
401 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
402 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
403 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
404 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]405 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
406 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
407 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
408 &quot;targetLink&quot;: &quot;A String&quot;,
409 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
410 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
411 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
412 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
413 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
414 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
415 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
416 # populated.
417 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
418 { # Database instance operation error.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]419 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]420 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
421 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]422 },
423 ],
424 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
425 },
426 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
427 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]428 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]429 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
430 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
431 # of the database table are loaded with CSV data.
432 &quot;A String&quot;,
433 ],
434 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
435 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]436 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
437 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
438 # specify a database, and is overridden by any database specification in the
439 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
440 # must be specified.
441 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
442 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
443 &quot;encryptionOptions&quot;: {
444 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
445 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
446 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
447 # write permissions to the bucket and read access to the file.
448 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
449 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
450 # write permissions to the bucket and read access to the file.
451 },
452 },
453 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
454 # &lt;code&gt;gs:
455 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
456 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
457 # // write permissions to the bucket and read access to the file.
458 &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
459 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
460 },
461 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
462 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
463 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]464 }</pre>
465</div>
466
467<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]468 <code class="details" id="list">list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]475 maxResults: integer, Maximum number of backup runs per response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]476 pageToken: string, A previously-returned page token representing part of the larger set of
477results to view.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]492 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]493 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;.
494 &quot;windowStartTime&quot;: &quot;A String&quot;, # The start time of the backup window during which this the backup was
495 # attempted in &lt;a href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt;
496 # format, for example &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
497 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
498 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup.
499 # Applies only to Second Generation instances.
500 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
501 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#diskEncryptionStatus&lt;/code&gt;.
502 },
503 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#backupRun&lt;/code&gt;.
504 &quot;error&quot;: { # Database instance operation error. # Information about why the backup operation failed. This is only present if
505 # the run has the FAILED status.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]506 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]507 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
508 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]509 },
510 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
511 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
512 # Applies only to Second Generation instances.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]513 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]514 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#diskEncryptionConfiguration&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]515 },
516 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
517 &quot;enqueuedTime&quot;: &quot;A String&quot;, # The time the run was enqueued in UTC timezone in &lt;a
518 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
519 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
520 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL
521 # instance.
522 &quot;endTime&quot;: &quot;A String&quot;, # The time the backup operation completed in UTC timezone in &lt;a
523 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
524 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
525 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
526 &quot;startTime&quot;: &quot;A String&quot;, # The time the backup operation actually started in UTC timezone in &lt;a
527 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
528 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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>