blob: 7ad8f260b1d2a600ee438a12faf09d81bee21833 [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 Bot0bf565c2020-12-09 08:56:03 -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 Botcc94ec82021-01-15 07:10:04 -0800117 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
118 &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*.
119 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
120 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
121 { # Database instance operation error.
122 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
123 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
124 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
125 },
126 ],
127 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
128 },
129 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
130 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
131 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800132 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800133 &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.
134 &quot;A String&quot;,
135 ],
136 &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.
137 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
138 &quot;offload&quot;: True or False, # Option for export offload.
139 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
140 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
141 &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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800142 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800143 &quot;schemaOnly&quot;: True or False, # Export only schemas.
144 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800145 &quot;A String&quot;,
146 ],
147 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800148 &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.
149 },
150 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
151 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
152 &quot;encryptionOptions&quot;: {
153 &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.
154 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
155 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800156 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800157 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800158 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
159 &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.
160 &quot;A String&quot;,
161 ],
162 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
163 },
164 &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.
165 &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.
166 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
167 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
168 &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.
169 },
170 &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*.
171 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
172 &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.
173 &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*
174 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
175 &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*.
176 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
177 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
178 &quot;targetLink&quot;: &quot;A String&quot;,
179 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
180 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
181}</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700182</div>
183
184<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700185 <code class="details" id="get">get(project, instance, id, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800186 <pre>Retrieves a resource containing information about a backup run.
187
188Args:
189 project: string, Project ID of the project that contains the instance. (required)
190 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
191 id: string, The ID of this Backup Run. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700192 x__xgafv: string, V1 error format.
193 Allowed values
194 1 - v1 error format
195 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800196
197Returns:
198 An object of the form:
199
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700200 { # A BackupRun resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800201 &quot;backupKind&quot;: &quot;A String&quot;, # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
202 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
203 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. Applies only to Second Generation instances.
204 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionConfiguration*.
205 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
206 },
207 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup. Applies only to Second Generation instances.
208 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionStatus*.
209 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
210 },
211 &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*.
212 &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*.
213 &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.
214 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
215 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
216 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
217 },
218 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
219 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
220 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupRun*.
221 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
222 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
223 &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*.
224 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
225 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;.
226 &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*.
227}</pre>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700228</div>
229
230<div class="method">
231 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700232 <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 -0700233
234Args:
235 project: string, Project ID of the project that contains the instance. (required)
236 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
237 body: object, The request body.
238 The object takes the form of:
239
240{ # A BackupRun resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800241 &quot;backupKind&quot;: &quot;A String&quot;, # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800242 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
243 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. Applies only to Second Generation instances.
244 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionConfiguration*.
245 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
246 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800247 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup. Applies only to Second Generation instances.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800248 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionStatus*.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800249 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800250 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800251 &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*.
252 &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*.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800253 &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.
254 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
255 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
256 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
257 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800258 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
259 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
260 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupRun*.
261 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800262 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800263 &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*.
264 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
265 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;.
266 &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*.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800267}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700268
Dan O'Mearadd494642020-05-01 07:42:23 -0700269 x__xgafv: string, V1 error format.
270 Allowed values
271 1 - v1 error format
272 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700273
274Returns:
275 An object of the form:
276
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800277 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
278 &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*.
279 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
280 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
281 { # Database instance operation error.
282 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
283 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
284 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
285 },
286 ],
287 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
288 },
289 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
290 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
291 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800292 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800293 &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.
294 &quot;A String&quot;,
295 ],
296 &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.
297 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
298 &quot;offload&quot;: True or False, # Option for export offload.
299 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
300 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
301 &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. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800302 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800303 &quot;schemaOnly&quot;: True or False, # Export only schemas.
304 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800305 &quot;A String&quot;,
306 ],
307 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800308 &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.
309 },
310 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
311 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
312 &quot;encryptionOptions&quot;: {
313 &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.
314 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
315 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800316 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800317 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800318 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
319 &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.
320 &quot;A String&quot;,
321 ],
322 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
323 },
324 &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.
325 &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.
326 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
327 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
328 &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.
329 },
330 &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*.
331 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
332 &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.
333 &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*
334 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
335 &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*.
336 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
337 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
338 &quot;targetLink&quot;: &quot;A String&quot;,
339 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
340 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
341}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800342</div>
343
344<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800345 <code class="details" id="list">list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700346 <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 -0800347
348Args:
349 project: string, Project ID of the project that contains the instance. (required)
350 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800351 maxResults: integer, Maximum number of backup runs per response.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800352 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 -0700353 x__xgafv: string, V1 error format.
354 Allowed values
355 1 - v1 error format
356 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800357
358Returns:
359 An object of the form:
360
361 { # Backup run list results.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800362 &quot;items&quot;: [ # A list of backup runs in reverse chronological order of the enqueued time.
363 { # A BackupRun resource.
364 &quot;backupKind&quot;: &quot;A String&quot;, # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
365 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
366 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. Applies only to Second Generation instances.
367 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionConfiguration*.
368 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800369 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800370 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup. Applies only to Second Generation instances.
371 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionStatus*.
372 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
373 },
374 &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*.
375 &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*.
376 &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.
377 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
378 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
379 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
380 },
381 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
382 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
383 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupRun*.
384 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
385 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
386 &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*.
387 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
388 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;.
389 &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*.
390 },
391 ],
392 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupRunsList*.
393 &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.
394}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800395</div>
396
397<div class="method">
398 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
399 <pre>Retrieves the next page of results.
400
401Args:
402 previous_request: The request for the previous page. (required)
403 previous_response: The response from the request for the previous page. (required)
404
405Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700406 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citroe633be12015-03-02 13:40:36 -0800407 page. Returns None if there are no more items in the collection.
408 </pre>
409</div>
410
411</body></html>