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