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'¶cgsnapshot
¶cgsnapshot_id
¶cluster_name
¶create
()¶created_at
¶delete_metadata_key
(context, key)¶deleted
¶deleted_at
¶destroy
()¶display_description
¶display_name
¶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)}¶group_snapshot
¶group_snapshot_id
¶host
¶All cleanable VO must have a host property/attribute.
id
¶metadata
¶model
¶alias of cinder.db.sqlalchemy.models.Snapshot
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.
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.
progress
¶project_id
¶provider_auth
¶provider_id
¶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.
snapshot_data_get_for_project
(context, project_id, volume_type_id=None, host=None)¶status
¶updated_at
¶user_id
¶volume
¶volume_id
¶volume_name
¶volume_size
¶volume_type_id
¶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)}¶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.
get_all_active_by_window
(context, begin, end)¶get_all_by_project
(context, project_id, search_opts, marker=None, limit=None, sort_keys=None, sort_dirs=None, offset=None)¶get_all_for_cgsnapshot
(context, cgsnapshot_id)¶get_all_for_group_snapshot
(context, group_snapshot_id)¶get_all_for_volume
(context, volume_id)¶get_by_host
(context, host, filters=None)¶get_snapshot_summary
(context, project_only, filters=None)¶objects
¶Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.