Cloud SQL Admin API . backupRuns

Instance Methods

close()

Close httplib2 connections.

delete(project, instance, id, x__xgafv=None)

Deletes the backup taken by a backup run.

get(project, instance, id, x__xgafv=None)

Retrieves a resource containing information about a backup run.

insert(project, instance, body=None, x__xgafv=None)

Creates a new backup run on demand. This method is applicable only to Second Generation instances.

list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)

Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
delete(project, instance, id, x__xgafv=None)
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 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. Next field: 18
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "code": "A String", # Identifies the specific error that occurred.
          "kind": "A String", # This is always *sql#operationError*.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
      "kind": "A String", # This is always *sql#operationErrors*.
    },
    "selfLink": "A String", # The URI of this resource.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "offload": True or False, # Option for export offload.
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "schemaOnly": True or False, # Export only schemas.
        "mysqlExportOptions": { # Options for exporting from MySQL.
          "masterData": 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.
        },
        "tables": [ # 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.
          "A String",
        ],
      },
      "kind": "A String", # This is always *sql#exportContext*.
      "fileType": "A String", # 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.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
      "databases": [ # 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.
        "A String",
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "kind": "A String", # This is always *sql#operation*.
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "user": "A String", # The email address of the user who initiated this operation.
    "backupContext": { # Backup context. # The context for backup operation, if applicable.
      "kind": "A String", # This is always *sql#backupContext*.
      "backupId": "A String", # The identifier of the backup.
    },
    "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
    "targetLink": "A String",
    "operationType": "A String", # 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*
    "targetId": "A String", # Name of the database instance related to this operation.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
      "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
      "kind": "A String", # This is always *sql#importContext*.
      "uri": "A String", # 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.
      "database": "A String", # 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.
      "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
        "encryptionOptions": {
          "pvkPassword": "A String", # Password that encrypts the private key
          "pvkPath": "A String", # 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.
          "certPath": "A String", # 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.
        },
      },
    },
  }
get(project, instance, id, x__xgafv=None)
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.
    "location": "A String", # Location of the backups.
    "windowStartTime": "A String", # 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*.
    "startTime": "A String", # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "description": "A String", # The description of this run, only applicable to on-demand backups.
    "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. Applies only to Second Generation instances.
      "kind": "A String", # This is always *sql#diskEncryptionConfiguration*.
      "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
    },
    "backupKind": "A String", # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
    "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "status": "A String", # The status of this run.
    "diskEncryptionStatus": { # Disk encryption status for an instance. # Encryption status specific to a backup. Applies only to Second Generation instances.
      "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
      "kind": "A String", # This is always *sql#diskEncryptionStatus*.
    },
    "kind": "A String", # This is always *sql#backupRun*.
    "id": "A String", # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
    "instance": "A String", # Name of the database instance.
    "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
      "code": "A String", # Identifies the specific error that occurred.
      "kind": "A String", # This is always *sql#operationError*.
      "message": "A String", # Additional information about the error encountered.
    },
    "type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
    "selfLink": "A String", # The URI of this resource.
  }
insert(project, instance, body=None, x__xgafv=None)
Creates a new backup run on demand. This method is applicable only to Second Generation instances.

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.
  "location": "A String", # Location of the backups.
  "windowStartTime": "A String", # 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*.
  "startTime": "A String", # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
  "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
  "description": "A String", # The description of this run, only applicable to on-demand backups.
  "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. Applies only to Second Generation instances.
    "kind": "A String", # This is always *sql#diskEncryptionConfiguration*.
    "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
  },
  "backupKind": "A String", # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
  "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
  "status": "A String", # The status of this run.
  "diskEncryptionStatus": { # Disk encryption status for an instance. # Encryption status specific to a backup. Applies only to Second Generation instances.
    "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
    "kind": "A String", # This is always *sql#diskEncryptionStatus*.
  },
  "kind": "A String", # This is always *sql#backupRun*.
  "id": "A String", # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
  "instance": "A String", # Name of the database instance.
  "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
    "code": "A String", # Identifies the specific error that occurred.
    "kind": "A String", # This is always *sql#operationError*.
    "message": "A String", # Additional information about the error encountered.
  },
  "type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
  "selfLink": "A String", # The URI of this resource.
}

  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. Next field: 18
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "code": "A String", # Identifies the specific error that occurred.
          "kind": "A String", # This is always *sql#operationError*.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
      "kind": "A String", # This is always *sql#operationErrors*.
    },
    "selfLink": "A String", # The URI of this resource.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "csvExportOptions": { # Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "offload": True or False, # Option for export offload.
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "schemaOnly": True or False, # Export only schemas.
        "mysqlExportOptions": { # Options for exporting from MySQL.
          "masterData": 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.
        },
        "tables": [ # 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.
          "A String",
        ],
      },
      "kind": "A String", # This is always *sql#exportContext*.
      "fileType": "A String", # 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.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
      "databases": [ # 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.
        "A String",
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "kind": "A String", # This is always *sql#operation*.
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "user": "A String", # The email address of the user who initiated this operation.
    "backupContext": { # Backup context. # The context for backup operation, if applicable.
      "kind": "A String", # This is always *sql#backupContext*.
      "backupId": "A String", # The identifier of the backup.
    },
    "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
    "targetLink": "A String",
    "operationType": "A String", # 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*
    "targetId": "A String", # Name of the database instance related to this operation.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
      "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
      "kind": "A String", # This is always *sql#importContext*.
      "uri": "A String", # 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.
      "database": "A String", # 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.
      "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
        "encryptionOptions": {
          "pvkPassword": "A String", # Password that encrypts the private key
          "pvkPath": "A String", # 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.
          "certPath": "A String", # 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.
        },
      },
    },
  }
list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)
Lists all backup runs associated with 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. 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.
    "items": [ # A list of backup runs in reverse chronological order of the enqueued time.
      { # A BackupRun resource.
        "location": "A String", # Location of the backups.
        "windowStartTime": "A String", # 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*.
        "startTime": "A String", # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
        "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
        "description": "A String", # The description of this run, only applicable to on-demand backups.
        "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. Applies only to Second Generation instances.
          "kind": "A String", # This is always *sql#diskEncryptionConfiguration*.
          "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
        },
        "backupKind": "A String", # Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
        "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
        "status": "A String", # The status of this run.
        "diskEncryptionStatus": { # Disk encryption status for an instance. # Encryption status specific to a backup. Applies only to Second Generation instances.
          "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
          "kind": "A String", # This is always *sql#diskEncryptionStatus*.
        },
        "kind": "A String", # This is always *sql#backupRun*.
        "id": "A String", # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
        "instance": "A String", # Name of the database instance.
        "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
          "code": "A String", # Identifies the specific error that occurred.
          "kind": "A String", # This is always *sql#operationError*.
          "message": "A String", # Additional information about the error encountered.
        },
        "type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
        "selfLink": "A String", # The URI of this resource.
      },
    ],
    "kind": "A String", # This is always *sql#backupRunsList*.
    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
  }
list_next(previous_request, previous_response)
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 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.