blob: a193ae32be248426301ceebe974490e3a249f748 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -08001<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 -070075<h1><a href="sqladmin_v1beta4.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1beta4.backupRuns.html">backupRuns</a></h1>
Craig Citroe633be12015-03-02 13:40:36 -080076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#delete">delete(project, instance, id, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -070082<p class="firstline">Deletes the backup taken by a backup run.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#get">get(project, instance, id, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -080085<p class="firstline">Retrieves a resource containing information about a backup run.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<p class="firstline">Creates a new backup run on demand. This method is applicable only to Second Generation instances.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070089<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080090 <code><a href="#list">list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091<p class="firstline">Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.</p>
Craig Citroe633be12015-03-02 13:40:36 -080092<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code class="details" id="delete">delete(project, instance, id, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700103 <pre>Deletes the backup taken by a backup run.
104
105Args:
106 project: string, Project ID of the project that contains the instance. (required)
107 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700108 id: string, The ID of the Backup Run to delete. To find a Backup Run ID, use the list method. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700113
114Returns:
115 An object of the form:
116
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800117 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
118 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
119 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
120 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700121 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700122 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
123 { # Database instance operation error.
124 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
125 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
126 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
127 },
128 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800129 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700130 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800131 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800132 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
133 &quot;encryptionOptions&quot;: {
134 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
135 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
136 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
137 },
138 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800139 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
140 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.
141 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.
142 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
143 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
144 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
145 &quot;A String&quot;,
146 ],
147 },
148 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
149 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800150 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800151 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
152 &quot;targetLink&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800153 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800154 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
155 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*
156 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
157 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
158 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
159 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupContext*.
160 },
161 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
162 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
163 &quot;schemaOnly&quot;: True or False, # Export only schemas.
164 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
165 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.
166 },
167 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
168 &quot;A String&quot;,
169 ],
170 },
171 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
172 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
173 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
174 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
175 },
176 &quot;offload&quot;: True or False, # Option for export offload.
177 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
178 &quot;databases&quot;: [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property.
179 &quot;A String&quot;,
180 ],
181 },
182 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
183 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
184 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700185 }</pre>
186</div>
187
188<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700189 <code class="details" id="get">get(project, instance, id, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800190 <pre>Retrieves a resource containing information about a backup run.
191
192Args:
193 project: string, Project ID of the project that contains the instance. (required)
194 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
195 id: string, The ID of this Backup Run. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700196 x__xgafv: string, V1 error format.
197 Allowed values
198 1 - v1 error format
199 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800200
201Returns:
202 An object of the form:
203
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700204 { # A BackupRun resource.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800205 &quot;endTime&quot;: &quot;A String&quot;, # The time the backup operation completed in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
206 &quot;error&quot;: { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
207 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
208 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
209 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
210 },
211 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup. Applies only to Second Generation instances.
212 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
213 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionStatus*.
214 },
215 &quot;windowStartTime&quot;: &quot;A String&quot;, # The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
216 &quot;backupKind&quot;: &quot;A String&quot;, # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
217 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
218 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
219 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
220 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
221 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupRun*.
222 &quot;enqueuedTime&quot;: &quot;A String&quot;, # The time the run was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
223 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
224 &quot;startTime&quot;: &quot;A String&quot;, # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
225 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. Applies only to Second Generation instances.
226 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
227 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionConfiguration*.
228 },
229 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
230 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;.
231 }</pre>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700232</div>
233
234<div class="method">
235 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700236 <pre>Creates a new backup run on demand. This method is applicable only to Second Generation instances.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700237
238Args:
239 project: string, Project ID of the project that contains the instance. (required)
240 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
241 body: object, The request body.
242 The object takes the form of:
243
244{ # A BackupRun resource.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800245 &quot;endTime&quot;: &quot;A String&quot;, # The time the backup operation completed in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
246 &quot;error&quot;: { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
247 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
248 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
249 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
250 },
251 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup. Applies only to Second Generation instances.
252 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
253 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionStatus*.
254 },
255 &quot;windowStartTime&quot;: &quot;A String&quot;, # The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
256 &quot;backupKind&quot;: &quot;A String&quot;, # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
257 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
258 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
259 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
260 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
261 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupRun*.
262 &quot;enqueuedTime&quot;: &quot;A String&quot;, # The time the run was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
263 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
264 &quot;startTime&quot;: &quot;A String&quot;, # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
265 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. Applies only to Second Generation instances.
266 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
267 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionConfiguration*.
268 },
269 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
270 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;.
271}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700272
Dan O'Mearadd494642020-05-01 07:42:23 -0700273 x__xgafv: string, V1 error format.
274 Allowed values
275 1 - v1 error format
276 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700277
278Returns:
279 An object of the form:
280
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800281 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18
282 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
283 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
284 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700285 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700286 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
287 { # Database instance operation error.
288 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
289 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
290 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
291 },
292 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800293 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700294 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800295 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800296 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
297 &quot;encryptionOptions&quot;: {
298 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
299 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
300 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
301 },
302 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800303 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
304 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.
305 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.
306 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
307 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
308 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
309 &quot;A String&quot;,
310 ],
311 },
312 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
313 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800314 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800315 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
316 &quot;targetLink&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800317 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800318 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
319 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*
320 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
321 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
322 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
323 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupContext*.
324 },
325 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
326 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
327 &quot;schemaOnly&quot;: True or False, # Export only schemas.
328 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
329 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.
330 },
331 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
332 &quot;A String&quot;,
333 ],
334 },
335 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
336 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.
337 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
338 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
339 },
340 &quot;offload&quot;: True or False, # Option for export offload.
341 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
342 &quot;databases&quot;: [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property.
343 &quot;A String&quot;,
344 ],
345 },
346 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
347 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
348 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
Craig Citroe633be12015-03-02 13:40:36 -0800349 }</pre>
350</div>
351
352<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800353 <code class="details" id="list">list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700354 <pre>Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.
Craig Citroe633be12015-03-02 13:40:36 -0800355
356Args:
357 project: string, Project ID of the project that contains the instance. (required)
358 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800359 maxResults: integer, Maximum number of backup runs per response.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800360 pageToken: string, A previously-returned page token representing part of the larger set of results to view.
Dan O'Mearadd494642020-05-01 07:42:23 -0700361 x__xgafv: string, V1 error format.
362 Allowed values
363 1 - v1 error format
364 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800365
366Returns:
367 An object of the form:
368
369 { # Backup run list results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700370 &quot;items&quot;: [ # A list of backup runs in reverse chronological order of the enqueued time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700371 { # A BackupRun resource.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800372 &quot;endTime&quot;: &quot;A String&quot;, # The time the backup operation completed in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
373 &quot;error&quot;: { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
374 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
375 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
376 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
Craig Citroe633be12015-03-02 13:40:36 -0800377 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800378 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup. Applies only to Second Generation instances.
379 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
380 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionStatus*.
381 },
382 &quot;windowStartTime&quot;: &quot;A String&quot;, # The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
383 &quot;backupKind&quot;: &quot;A String&quot;, # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
384 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
385 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
386 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
387 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
388 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupRun*.
389 &quot;enqueuedTime&quot;: &quot;A String&quot;, # The time the run was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
390 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
391 &quot;startTime&quot;: &quot;A String&quot;, # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
392 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. Applies only to Second Generation instances.
393 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
394 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionConfiguration*.
395 },
396 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
397 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;.
398 },
Craig Citroe633be12015-03-02 13:40:36 -0800399 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800400 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupRunsList*.
401 &quot;nextPageToken&quot;: &quot;A String&quot;, # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
Craig Citroe633be12015-03-02 13:40:36 -0800402 }</pre>
403</div>
404
405<div class="method">
406 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
407 <pre>Retrieves the next page of results.
408
409Args:
410 previous_request: The request for the previous page. (required)
411 previous_response: The response from the request for the previous page. (required)
412
413Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700414 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citroe633be12015-03-02 13:40:36 -0800415 page. Returns None if there are no more items in the collection.
416 </pre>
417</div>
418
419</body></html>