otcextensions.sdk.cbr.v3.task¶
The CBR Task Class¶
The Task
class inherits from
Resource
.
-
class
otcextensions.sdk.cbr.v3.task.
Task
(_synchronized=False, connection=None, **attrs)¶ CBR Task Resource
The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
-
checkpoint_id
¶ Properties Backup record ID
-
created_at
¶ Creation time
-
ended_at
¶ Task end time
-
error_info
¶ Task error message
-
extra_info
¶ Task extension information
-
id
¶ Task ID
-
operation_type
¶ Task type
-
policy_id
¶ Policy ID
-
project_id
¶ Project ID
-
provider_id
¶ Backup provider ID
-
started_at
¶ Task start time
-
status
¶ Task status
-
updated_at
¶ Modification time
-
vault_id
¶ ID of the vault with which the target resource is associated
-
vault_name
¶ Name of the vault with which the target resource is associated
-
class
otcextensions.sdk.cbr.v3.task.
ErrorInfoSpec
(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
-
code
¶ Properties Error code
-
message
¶ Error message
-
class
otcextensions.sdk.cbr.v3.task.
ExtendInfoBackup
(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
-
app_consistency_error_code
¶ Properties Error code returned if application-consistent backup fails
-
app_consistency_error_mess
¶ Error message returned if application-consistent backup fails
-
app_consistency_status
¶ Application-consistent backup status
-
backup_id
¶ Backup ID
-
backup_name
¶ Backup name
-
incremental
¶ Whether incremental backup is used
-
class
otcextensions.sdk.cbr.v3.task.
ExtendInfoCommon
(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
-
progress
¶ Properties Progress of the query task
-
request_id
¶ Request ID
-
task_id
¶ Backup task ID
-
class
otcextensions.sdk.cbr.v3.task.
ExtendInfoDelete
(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
-
backup_id
¶ Properties Backup ID
-
backup_name
¶ Backup name
-
class
otcextensions.sdk.cbr.v3.task.
ExtendInfoSync
(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
-
sync_backup_num
¶ Properties Number of synchronized backups
-
delete_backup_num
¶ Number of deleted backups
-
err_sync_backup_num
¶ Number of backups that fail to be synchronized
-
class
otcextensions.sdk.cbr.v3.task.
ExtendInfoRestore
(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
-
backup_id
¶ Properties Backup ID
-
backup_name
¶ Backup name
-
target_resource_id
¶ ID of the resource to be restored
-
target_resource_name
¶ Name of the resource to be restored
-
class
otcextensions.sdk.cbr.v3.task.
ExtendInfoVaultDelete
(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
-
fail_count
¶ Properties Number of resources that fail to be deleted
-
total_count
¶ Number of deleted backups
-
class
otcextensions.sdk.cbr.v3.task.
ResourceSpec
(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
-
extra_info
¶ Properties Additional information of the resource
-
id
¶ ID of the resource to be backed up
-
name
¶ Name of the resource to be backed up
-
type
¶ Type of the resource to be backed up
-
class
otcextensions.sdk.cbr.v3.task.
ExtendInfoRemoveResources
(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
-
fail_count
¶ Properties Number of resources that fail to be deleted
-
total_count
¶ Number of deleted backups
-
resources
¶ Resources
-
class
otcextensions.sdk.cbr.v3.task.
ExtraInfoSpec
(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
-
backup
¶ Properties Extended parameters of backup
-
common
¶ Common parameters
-
delete
¶ Extended parameters of deletion
-
sync
¶ Extended parameters of synchronization
-
remove_resources
¶ Extended parameters of removing resources from a vault
-
resource_info
¶ Resource information
-
restore
¶ Extended parameters of restoration
-
vault_delete
¶ Extended parameters of deleting a vault