cinder.objects.snapshot module¶
-
class
Snapshot
(*args, **kwargs)¶ Bases:
cinder.objects.cleanable.CinderCleanableObject
,cinder.objects.base.CinderObject
,cinder.objects.base.CinderObjectDictCompat
,cinder.objects.base.CinderComparableObject
,cinder.objects.base.ClusteredObject
-
OPTIONAL_FIELDS
= ('volume', 'metadata', 'cgsnapshot', 'group_snapshot')¶
-
VERSION
= '1.5'¶
-
property
cgsnapshot
¶
-
property
cgsnapshot_id
¶
-
property
cluster_name
¶
-
create
()¶
-
property
created_at
¶
-
delete_metadata_key
(context, key)¶
-
property
deleted
¶
-
property
deleted_at
¶
-
destroy
()¶
-
property
display_description
¶
-
property
display_name
¶
-
property
encryption_key_id
¶
-
fields
= {'cgsnapshot': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'cgsnapshot_id': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deleted': Boolean(default=False,nullable=True), 'deleted_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'display_description': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'display_name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'encryption_key_id': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'group_snapshot': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'group_snapshot_id': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'id': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'metadata': Dict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'progress': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'project_id': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provider_auth': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provider_id': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provider_location': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'status': SnapshotStatus(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True,valid_values=('error', 'available', 'creating', 'deleting', 'deleted', 'updating', 'error_deleting', 'unmanaging', 'backing-up', 'restoring')), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'user_id': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'volume': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'volume_id': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'volume_size': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'volume_type_id': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}¶
-
property
group_snapshot
¶
-
property
group_snapshot_id
¶
-
property
host
¶ All cleanable VO must have a host property/attribute.
-
property
id
¶
-
property
metadata
¶
-
model
¶ alias of
cinder.db.sqlalchemy.models.Snapshot
-
property
name
¶
-
obj_extra_fields
= ['name', 'volume_name']¶
-
obj_load_attr
(attrname)¶ Load an additional attribute from the real object.
This should load self.$attrname and cache any data that might be useful for future load operations.
-
obj_make_compatible
(primitive, target_version)¶ Make an object representation compatible with a target version.
-
obj_reset_changes
(fields=None)¶ Reset the list of fields that have been changed.
- Parameters
fields – List of fields to reset, or “all” if None.
recursive – Call obj_reset_changes(recursive=True) on any sub-objects within the list of fields being reset.
This is NOT “revert to previous values”.
Specifying fields on recursive resets will only be honored at the top level. Everything below the top will reset all.
-
obj_what_changed
()¶ Returns a set of fields that have been modified.
-
property
progress
¶
-
property
project_id
¶
-
property
provider_auth
¶
-
property
provider_id
¶
-
property
provider_location
¶
-
save
()¶ Save the changed fields back to the store.
This is optional for subclasses, but is presented here in the base class for consistency among those that do.
-
classmethod
snapshot_data_get_for_project
(context, project_id, volume_type_id=None, host=None)¶
-
property
status
¶
-
property
updated_at
¶
-
property
user_id
¶
-
property
volume
¶
-
property
volume_id
¶
-
property
volume_name
¶
-
property
volume_size
¶
-
property
volume_type_id
¶
-
-
class
SnapshotList
(*args, **kwargs)¶ Bases:
cinder.objects.base.ObjectListBase
,cinder.objects.base.CinderObject
-
VERSION
= '1.0'¶
-
fields
= {'objects': List(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False)}¶
-
classmethod
get_all
(context, filters, marker=None, limit=None, sort_keys=None, sort_dirs=None, offset=None)¶ Get all snapshot given some search_opts (filters).
Special filters accepted are host and cluster_name, that refer to the volume’s fields.
-
classmethod
get_all_active_by_window
(context, begin, end)¶
-
classmethod
get_all_by_project
(context, project_id, search_opts, marker=None, limit=None, sort_keys=None, sort_dirs=None, offset=None)¶
-
classmethod
get_all_for_cgsnapshot
(context, cgsnapshot_id)¶
-
classmethod
get_all_for_group_snapshot
(context, group_snapshot_id)¶
-
classmethod
get_all_for_volume
(context, volume_id)¶
-
classmethod
get_by_host
(context, host, filters=None)¶
-
classmethod
get_snapshot_summary
(context, project_only, filters=None)¶
-
property
objects
¶
-