Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / sqladmin_v1beta4.backupRuns.html
blob: 5a38d328c24ce10ce5f8da7136bd3a18e2eaebdd [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="sqladmin_v1beta4.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1beta4.backupRuns.html">backupRuns</a></h1>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <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 -0700[diff] [blame]81 <code><a href="#delete">delete(project, instance, id, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]82<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 -0700[diff] [blame]84 <code><a href="#get">get(project, instance, id, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]85<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 -0700[diff] [blame]87 <code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bota36e3b12021-07-27 00:20:26 -0700[diff] [blame]88<p class="firstline">Creates a new backup run on demand.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]89<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]90 <code><a href="#list">list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700[diff] [blame]91<p class="firstline">Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]92<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 -0700[diff] [blame]97 <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 -0700[diff] [blame]102 <code class="details" id="delete">delete(project, instance, id, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]103 <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)
yoshi-code-bota36e3b12021-07-27 00:20:26 -0700[diff] [blame]108 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 -0700[diff] [blame]109 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 -0700[diff] [blame]113
114Returns:
115 An object of the form:
116
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]117 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]118 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
119 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
120 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupContext*.
121 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]122 &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*.
123 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
124 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
125 { # Database instance operation error.
126 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
127 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
128 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
129 },
130 ],
131 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
132 },
133 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]134 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]135 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]136 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]137 &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. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]138 &quot;A String&quot;,
139 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]140 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]141 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
142 &quot;offload&quot;: True or False, # Option for export offload.
143 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
144 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]145 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]146 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]147 &quot;schemaOnly&quot;: True or False, # Export only schemas.
148 &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 -0800[diff] [blame]149 &quot;A String&quot;,
150 ],
151 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]152 &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 request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]153 },
154 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
155 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
156 &quot;encryptionOptions&quot;: {
157 &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.
158 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
159 &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 -0800[diff] [blame]160 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]161 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]162 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
163 &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.
164 &quot;A String&quot;,
165 ],
166 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
167 },
168 &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.
169 &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.
170 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
171 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]172 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]173 },
174 &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*.
175 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
176 &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.
177 &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*
178 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
179 &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*.
180 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
181 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
182 &quot;targetLink&quot;: &quot;A String&quot;,
183 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
184 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
185}</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]186</div>
187
188<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]189 <code class="details" id="get">get(project, instance, id, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]190 <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)
yoshi-code-bota36e3b12021-07-27 00:20:26 -0700[diff] [blame]195 id: string, The ID of this backup run. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]196 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 -0800[diff] [blame]200
201Returns:
202 An object of the form:
203
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]204 { # A BackupRun resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]205 &quot;backupKind&quot;: &quot;A String&quot;, # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
206 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
yoshi-code-bota36e3b12021-07-27 00:20:26 -0700[diff] [blame]207 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]208 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionConfiguration*.
209 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
210 },
yoshi-code-bota36e3b12021-07-27 00:20:26 -0700[diff] [blame]211 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]212 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionStatus*.
213 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
214 },
215 &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*.
216 &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*.
217 &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.
218 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
219 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
220 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
221 },
222 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
223 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
224 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupRun*.
225 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
226 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
227 &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*.
228 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]229 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;. This field defaults to &quot;ON_DEMAND&quot; and is ignored, when specified for insert requests.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]230 &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*.
231}</pre>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]232</div>
233
234<div class="method">
235 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
yoshi-code-bota36e3b12021-07-27 00:20:26 -0700[diff] [blame]236 <pre>Creates a new backup run on demand.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]237
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 Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]245 &quot;backupKind&quot;: &quot;A String&quot;, # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]246 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
yoshi-code-bota36e3b12021-07-27 00:20:26 -0700[diff] [blame]247 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]248 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionConfiguration*.
249 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
250 },
yoshi-code-bota36e3b12021-07-27 00:20:26 -0700[diff] [blame]251 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]252 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionStatus*.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]253 &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 -0800[diff] [blame]254 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]255 &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*.
256 &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 -0800[diff] [blame]257 &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.
258 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
259 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
260 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
261 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]262 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
263 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
264 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupRun*.
265 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]266 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]267 &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*.
268 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]269 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;. This field defaults to &quot;ON_DEMAND&quot; and is ignored, when specified for insert requests.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]270 &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 -0800[diff] [blame]271}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]272
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]273 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 -0700[diff] [blame]277
278Returns:
279 An object of the form:
280
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]281 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]282 &quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
283 &quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
284 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupContext*.
285 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]286 &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*.
287 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
288 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
289 { # Database instance operation error.
290 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
291 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
292 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
293 },
294 ],
295 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
296 },
297 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]298 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]299 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]300 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]301 &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. *SQL Server instances:* You must specify one database to be exported, and the *fileType* must be *BAK*.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]302 &quot;A String&quot;,
303 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]304 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]305 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
306 &quot;offload&quot;: True or False, # Option for export offload.
307 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
308 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]309 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]310 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]311 &quot;schemaOnly&quot;: True or False, # Export only schemas.
312 &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 -0800[diff] [blame]313 &quot;A String&quot;,
314 ],
315 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]316 &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 request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]317 },
318 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
319 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
320 &quot;encryptionOptions&quot;: {
321 &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.
322 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
323 &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 -0800[diff] [blame]324 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]325 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]326 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
327 &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.
328 &quot;A String&quot;,
329 ],
330 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
331 },
332 &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.
333 &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.
334 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
335 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]336 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]337 },
338 &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*.
339 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
340 &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.
341 &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*
342 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
343 &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*.
344 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
345 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
346 &quot;targetLink&quot;: &quot;A String&quot;,
347 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
348 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
349}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]350</div>
351
352<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]353 <code class="details" id="list">list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)</code>
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700[diff] [blame]354 <pre>Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]355
356Args:
357 project: string, Project ID of the project that contains the instance. (required)
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700[diff] [blame]358 instance: string, Cloud SQL instance ID, or &quot;-&quot; for all instances. This does not include the project ID. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]359 maxResults: integer, Maximum number of backup runs per response.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]360 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 -0700[diff] [blame]361 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 -0800[diff] [blame]365
366Returns:
367 An object of the form:
368
369 { # Backup run list results.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]370 &quot;items&quot;: [ # A list of backup runs in reverse chronological order of the enqueued time.
371 { # A BackupRun resource.
372 &quot;backupKind&quot;: &quot;A String&quot;, # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
373 &quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
yoshi-code-bota36e3b12021-07-27 00:20:26 -0700[diff] [blame]374 &quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]375 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionConfiguration*.
376 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]377 },
yoshi-code-bota36e3b12021-07-27 00:20:26 -0700[diff] [blame]378 &quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]379 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#diskEncryptionStatus*.
380 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
381 },
382 &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*.
383 &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*.
384 &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.
385 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
386 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
387 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
388 },
389 &quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
390 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
391 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#backupRun*.
392 &quot;location&quot;: &quot;A String&quot;, # Location of the backups.
393 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
394 &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*.
395 &quot;status&quot;: &quot;A String&quot;, # The status of this run.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]396 &quot;type&quot;: &quot;A String&quot;, # The type of this run; can be either &quot;AUTOMATED&quot; or &quot;ON_DEMAND&quot;. This field defaults to &quot;ON_DEMAND&quot; and is ignored, when specified for insert requests.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]397 &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*.
398 },
399 ],
400 &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.
402}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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 -0700[diff] [blame]414 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]415 page. Returns None if there are no more items in the collection.
416 </pre>
417</div>
418
419</body></html>