Google Git
Sign in
android / platform / external / python / google-api-python-client / refs/heads/main / . / docs / dyn / sqladmin_v1.backupRuns.html
blob: d6cc0d7c06f04c0d51d3effa4cd52b9ec71b4192 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="sqladmin_v1.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1.backupRuns.html">backupRuns</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, instance, id, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the backup taken by a backup run.</p>
<p class="toc_element">
<code><a href="#get">get(project, instance, id, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a resource containing information about a backup run.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new backup run on demand.</p>
<p class="toc_element">
<code><a href="#list">list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, instance, id, x__xgafv=None)</code>
<pre>Deletes the backup taken by a backup run.
Args:
project: string, Project ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
id: string, The ID of the backup run to delete. To find a backup run ID, use the [list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/backupRuns/list) method. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
&quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
&quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#backupContext**.
},
&quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
&quot;errors&quot;: [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
&quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationError**.
&quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
},
],
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationErrors**.
},
&quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
&quot;csvExportOptions&quot;: { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.
&quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
&quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
&quot;linesTerminatedBy&quot;: &quot;A String&quot;, # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
&quot;quoteCharacter&quot;: &quot;A String&quot;, # Specifies the quoting character to be used when a data value is quoted.
&quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
},
&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**.
&quot;A String&quot;,
],
&quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#exportContext**.
&quot;offload&quot;: True or False, # Option for export offload.
&quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
&quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
&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.
},
&quot;schemaOnly&quot;: True or False, # Export only schemas.
&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.
&quot;A String&quot;,
],
},
&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.
},
&quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
&quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
&quot;encryptionOptions&quot;: {
&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.
&quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
&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.
},
},
&quot;csvImportOptions&quot;: { # Options for importing data as CSV.
&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.
&quot;A String&quot;,
],
&quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
&quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
&quot;linesTerminatedBy&quot;: &quot;A String&quot;, # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
&quot;quoteCharacter&quot;: &quot;A String&quot;, # Specifies the quoting character to be used when a data value is quoted.
&quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
},
&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.
&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.
&quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#importContext**.
&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.
},
&quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operation**.
&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.
&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**
&quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
&quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&quot;status&quot;: &quot;A String&quot;, # The status of an operation.
&quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
&quot;targetLink&quot;: &quot;A String&quot;,
&quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
&quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, instance, id, x__xgafv=None)</code>
<pre>Retrieves a resource containing information about a backup run.
Args:
project: string, Project ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
id: string, The ID of this backup run. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A BackupRun resource.
&quot;backupKind&quot;: &quot;A String&quot;, # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
&quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
&quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#diskEncryptionConfiguration**.
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
},
&quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#diskEncryptionStatus**.
&quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
},
&quot;endTime&quot;: &quot;A String&quot;, # The time the backup operation completed in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&quot;enqueuedTime&quot;: &quot;A String&quot;, # The time the run was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&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.
&quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationError**.
&quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
},
&quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
&quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#backupRun**.
&quot;location&quot;: &quot;A String&quot;, # Location of the backups.
&quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
&quot;startTime&quot;: &quot;A String&quot;, # The time the backup operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&quot;status&quot;: &quot;A String&quot;, # The status of this run.
&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.
&quot;windowStartTime&quot;: &quot;A String&quot;, # The start time of the backup window during which this the backup was attempted in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
<pre>Creates a new backup run on demand.
Args:
project: string, Project ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
body: object, The request body.
The object takes the form of:
{ # A BackupRun resource.
&quot;backupKind&quot;: &quot;A String&quot;, # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
&quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
&quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#diskEncryptionConfiguration**.
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
},
&quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#diskEncryptionStatus**.
&quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
},
&quot;endTime&quot;: &quot;A String&quot;, # The time the backup operation completed in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&quot;enqueuedTime&quot;: &quot;A String&quot;, # The time the run was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&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.
&quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationError**.
&quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
},
&quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
&quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#backupRun**.
&quot;location&quot;: &quot;A String&quot;, # Location of the backups.
&quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
&quot;startTime&quot;: &quot;A String&quot;, # The time the backup operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&quot;status&quot;: &quot;A String&quot;, # The status of this run.
&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.
&quot;windowStartTime&quot;: &quot;A String&quot;, # The start time of the backup window during which this the backup was attempted in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
&quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
&quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#backupContext**.
},
&quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
&quot;errors&quot;: [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
&quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationError**.
&quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
},
],
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationErrors**.
},
&quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
&quot;csvExportOptions&quot;: { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.
&quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
&quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
&quot;linesTerminatedBy&quot;: &quot;A String&quot;, # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
&quot;quoteCharacter&quot;: &quot;A String&quot;, # Specifies the quoting character to be used when a data value is quoted.
&quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
},
&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**.
&quot;A String&quot;,
],
&quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#exportContext**.
&quot;offload&quot;: True or False, # Option for export offload.
&quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
&quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
&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.
},
&quot;schemaOnly&quot;: True or False, # Export only schemas.
&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.
&quot;A String&quot;,
],
},
&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.
},
&quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
&quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
&quot;encryptionOptions&quot;: {
&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.
&quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
&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.
},
},
&quot;csvImportOptions&quot;: { # Options for importing data as CSV.
&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.
&quot;A String&quot;,
],
&quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
&quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
&quot;linesTerminatedBy&quot;: &quot;A String&quot;, # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
&quot;quoteCharacter&quot;: &quot;A String&quot;, # Specifies the quoting character to be used when a data value is quoted.
&quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
},
&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.
&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.
&quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#importContext**.
&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.
},
&quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operation**.
&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.
&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**
&quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
&quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&quot;status&quot;: &quot;A String&quot;, # The status of an operation.
&quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
&quot;targetLink&quot;: &quot;A String&quot;,
&quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
&quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)</code>
<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.
Args:
project: string, Project ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance ID, or &quot;-&quot; for all instances. This does not include the project ID. (required)
maxResults: integer, Maximum number of backup runs per response.
pageToken: string, A previously-returned page token representing part of the larger set of results to view.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Backup run list results.
&quot;items&quot;: [ # A list of backup runs in reverse chronological order of the enqueued time.
{ # A BackupRun resource.
&quot;backupKind&quot;: &quot;A String&quot;, # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
&quot;description&quot;: &quot;A String&quot;, # The description of this run, only applicable to on-demand backups.
&quot;diskEncryptionConfiguration&quot;: { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#diskEncryptionConfiguration**.
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Resource name of KMS key for disk encryption
},
&quot;diskEncryptionStatus&quot;: { # Disk encryption status for an instance. # Encryption status specific to a backup.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#diskEncryptionStatus**.
&quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # KMS key version used to encrypt the Cloud SQL instance resource
},
&quot;endTime&quot;: &quot;A String&quot;, # The time the backup operation completed in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&quot;enqueuedTime&quot;: &quot;A String&quot;, # The time the run was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&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.
&quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#operationError**.
&quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
},
&quot;id&quot;: &quot;A String&quot;, # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
&quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#backupRun**.
&quot;location&quot;: &quot;A String&quot;, # Location of the backups.
&quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
&quot;startTime&quot;: &quot;A String&quot;, # The time the backup operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
&quot;status&quot;: &quot;A String&quot;, # The status of this run.
&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.
&quot;windowStartTime&quot;: &quot;A String&quot;, # The start time of the backup window during which this the backup was attempted in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
},
],
&quot;kind&quot;: &quot;A String&quot;, # This is always **sql#backupRunsList**.
&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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>