openstack.block_storage.v2.snapshot¶
The Snapshot Class¶
The Snapshot
class inherits from Resource
.
- class openstack.block_storage.v2.snapshot.Snapshot(_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.
- id¶
A ID representing this snapshot.
- name¶
Name of the snapshot. Default is None.
- status¶
The current status of this snapshot. Potential values are creating, available, deleting, error, and error_deleting.
- description¶
Description of snapshot. Default is None.
- created_at¶
The timestamp of this snapshot creation.
- metadata¶
Metadata associated with this snapshot.
- volume_id¶
The ID of the volume this snapshot was taken of.
- size¶
The size of the volume, in GBs.
- is_forced¶
Indicate whether to create snapshot, even if the volume is attached. Default is
False
. Type: bool
The SnapshotDetail Class¶
The SnapshotDetail
class inherits from
Snapshot
.
- class openstack.block_storage.v2.snapshot.SnapshotDetail(_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¶
The percentage of completeness the snapshot is currently at.
- project_id¶
The project ID this snapshot is associated with.