docs: Add missing docs for block storage v3 proxy APIs
While we're here, reshuffle some of the APIs to logically group them. Change-Id: Ib8254de9bcc33f76644ed184db8883292ba650fd Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane
parent
0898398415
commit
19c070a405
@ -17,28 +17,80 @@ Volume Operations
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: create_volume, delete_volume, get_volume, volumes
|
||||
:members: create_volume, delete_volume, get_volume, find_volume,
|
||||
volumes, get_volume_metadata, set_volume_metadata,
|
||||
delete_volume_metadata, extend_volume, set_volume_readonly,
|
||||
retype_volume, set_volume_bootable_status, reset_volume_status,
|
||||
revert_volume_to_snapshot, attach_volume, detach_volume,
|
||||
unmanage_volume, migrate_volume, complete_volume_migration,
|
||||
upload_volume_to_image, reserve_volume, unreserve_volume,
|
||||
begin_volume_detaching, abort_volume_detaching,
|
||||
init_volume_attachment, terminate_volume_attachment,
|
||||
|
||||
Backend Pools Operations
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: backend_pools
|
||||
|
||||
Backup Operations
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: create_backup, delete_backup, get_backup, backups, restore_backup
|
||||
:members: create_backup, delete_backup, get_backup, find_backup, backups,
|
||||
restore_backup, reset_backup,
|
||||
|
||||
Availability Zone Operations
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: availability_zones
|
||||
|
||||
Limits Operations
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: get_limits
|
||||
|
||||
Capabilities Operations
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: get_capabilities
|
||||
|
||||
Group Type Operations
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: create_group_type, delete_group_type, update_group_type,
|
||||
get_group_type, find_group_type, group_types,
|
||||
|
||||
Type Operations
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: create_type, delete_type, get_type, types
|
||||
:members: create_type, delete_type, update_type, get_type, find_type, types,
|
||||
update_type_extra_specs, delete_type_extra_specs, get_type_access,
|
||||
add_type_access, remove_type_access, get_type_encryption,
|
||||
create_type_encryption, delete_type_encryption,
|
||||
update_type_encryption
|
||||
|
||||
Snapshot Operations
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: create_snapshot, delete_snapshot, get_snapshot, snapshots
|
||||
:members: create_snapshot, delete_snapshot, update_snapshot, get_snapshot,
|
||||
find_snapshot, snapshots, get_snapshot_metadata,
|
||||
set_snapshot_metadata, delete_snapshot_metadata, reset_snapshot,
|
||||
set_snapshot_status
|
||||
|
||||
Stats Operations
|
||||
^^^^^^^^^^^^^^^^
|
||||
@ -49,7 +101,15 @@ Stats Operations
|
||||
|
||||
QuotaSet Operations
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: get_quota_set, get_quota_set_defaults,
|
||||
revert_quota_set, update_quota_set
|
||||
|
||||
Helpers
|
||||
^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: wait_for_status, wait_for_delete
|
||||
|
||||
@ -98,8 +98,7 @@ class Proxy(_base_proxy.BaseBlockStorageProxy):
|
||||
|
||||
:param snapshot: Either the ID of a snapshot or a
|
||||
:class:`~openstack.block_storage.v3.snapshot.Snapshot` instance.
|
||||
:attrs kwargs: The attributes to update on the snapshot represented
|
||||
by ``snapshot``.
|
||||
:param dict attrs: The attributes to update on the snapshot.
|
||||
|
||||
:returns: The updated snapshot
|
||||
:rtype: :class:`~openstack.block_storage.v3.snapshot.Snapshot`
|
||||
@ -127,6 +126,54 @@ class Proxy(_base_proxy.BaseBlockStorageProxy):
|
||||
snapshot = self._get_resource(_snapshot.Snapshot, snapshot)
|
||||
snapshot.force_delete(self)
|
||||
|
||||
def get_snapshot_metadata(self, snapshot):
|
||||
"""Return a dictionary of metadata for a snapshot
|
||||
|
||||
:param snapshot: Either the ID of a snapshot or a
|
||||
:class:`~openstack.block_storage.v3.snapshot.Snapshot`.
|
||||
|
||||
:returns: A
|
||||
:class:`~openstack.block_storage.v3.snapshot.Snapshot` with the
|
||||
snapshot's metadata. All keys and values are Unicode text.
|
||||
:rtype: :class:`~openstack.block_storage.v3.snapshot.Snapshot`
|
||||
"""
|
||||
snapshot = self._get_resource(_snapshot.Snapshot, snapshot)
|
||||
return snapshot.fetch_metadata(self)
|
||||
|
||||
def set_snapshot_metadata(self, snapshot, **metadata):
|
||||
"""Update metadata for a snapshot
|
||||
|
||||
:param snapshot: Either the ID of a snapshot or a
|
||||
:class:`~openstack.block_storage.v3.snapshot.Snapshot`.
|
||||
:param kwargs metadata: Key/value pairs to be updated in the snapshot's
|
||||
metadata. No other metadata is modified by this call. All keys
|
||||
and values are stored as Unicode.
|
||||
|
||||
:returns: A
|
||||
:class:`~openstack.block_storage.v3.snapshot.Snapshot` with the
|
||||
snapshot's metadata. All keys and values are Unicode text.
|
||||
:rtype: :class:`~openstack.block_storage.v3.snapshot.Snapshot`
|
||||
"""
|
||||
snapshot = self._get_resource(_snapshot.Snapshot, snapshot)
|
||||
return snapshot.set_metadata(self, metadata=metadata)
|
||||
|
||||
def delete_snapshot_metadata(self, snapshot, keys=None):
|
||||
"""Delete metadata for a snapshot
|
||||
|
||||
:param snapshot: Either the ID of a snapshot or a
|
||||
:class:`~openstack.block_storage.v3.snapshot.Snapshot`.
|
||||
:param list keys: The keys to delete. If left empty complete
|
||||
metadata will be removed.
|
||||
|
||||
:rtype: ``None``
|
||||
"""
|
||||
snapshot = self._get_resource(_snapshot.Snapshot, snapshot)
|
||||
if keys is not None:
|
||||
for key in keys:
|
||||
snapshot.delete_metadata_item(self, key)
|
||||
else:
|
||||
snapshot.delete_metadata(self)
|
||||
|
||||
# ====== SNAPSHOT ACTIONS ======
|
||||
def reset_snapshot(self, snapshot, status):
|
||||
"""Reset status of the snapshot
|
||||
@ -221,7 +268,6 @@ class Proxy(_base_proxy.BaseBlockStorageProxy):
|
||||
:param type: The value can be either the ID of a type or a
|
||||
:class:`~openstack.block_storage.v3.type.Type` instance.
|
||||
:param dict attrs: The attributes to update on the type
|
||||
represented by ``value``.
|
||||
|
||||
:returns: The updated type
|
||||
:rtype: :class:`~openstack.block_storage.v3.type.Type`
|
||||
@ -233,8 +279,7 @@ class Proxy(_base_proxy.BaseBlockStorageProxy):
|
||||
|
||||
:param type: The value can be either the ID of a type or a
|
||||
:class:`~openstack.block_storage.v3.type.Type` instance.
|
||||
:param dict attrs: The extra_spec attributes to update on the
|
||||
type represented by ``value``.
|
||||
:param dict attrs: The extra spec attributes to update on the type
|
||||
|
||||
:returns: A dict containing updated extra_specs
|
||||
"""
|
||||
@ -362,17 +407,21 @@ class Proxy(_base_proxy.BaseBlockStorageProxy):
|
||||
self._delete(_type.TypeEncryption, encryption,
|
||||
ignore_missing=ignore_missing)
|
||||
|
||||
def update_type_encryption(self, encryption=None,
|
||||
volume_type=None, **attrs):
|
||||
def update_type_encryption(
|
||||
self,
|
||||
encryption=None,
|
||||
volume_type=None,
|
||||
**attrs,
|
||||
):
|
||||
"""Update a type
|
||||
|
||||
:param encryption: The value can be None or a
|
||||
:class:`~openstack.block_storage.v3.type.TypeEncryption`
|
||||
instance. If encryption_id is None then
|
||||
volume_type_id must be specified.
|
||||
|
||||
instance. If this is ``None`` then ``volume_type_id`` must be
|
||||
specified.
|
||||
:param volume_type: The value can be the ID of a type or a
|
||||
:class:`~openstack.block_storage.v3.type.Type`
|
||||
instance. Required if encryption_id is None.
|
||||
:class:`~openstack.block_storage.v3.type.Type` instance.
|
||||
Required if ``encryption_id`` is None.
|
||||
:param dict attrs: The attributes to update on the type encryption.
|
||||
|
||||
:returns: The updated type encryption
|
||||
@ -381,9 +430,11 @@ class Proxy(_base_proxy.BaseBlockStorageProxy):
|
||||
|
||||
if volume_type:
|
||||
volume_type = self._get_resource(_type.Type, volume_type)
|
||||
encryption = self._get(_type.TypeEncryption,
|
||||
volume_type=volume_type.id,
|
||||
requires_id=False)
|
||||
encryption = self._get(
|
||||
_type.TypeEncryption,
|
||||
volume_type=volume_type.id,
|
||||
requires_id=False,
|
||||
)
|
||||
|
||||
return self._update(_type.TypeEncryption, encryption, **attrs)
|
||||
|
||||
@ -466,6 +517,52 @@ class Proxy(_base_proxy.BaseBlockStorageProxy):
|
||||
volume = self._get_resource(_volume.Volume, volume)
|
||||
volume.force_delete(self)
|
||||
|
||||
def get_volume_metadata(self, volume):
|
||||
"""Return a dictionary of metadata for a volume
|
||||
|
||||
:param volume: Either the ID of a volume or a
|
||||
:class:`~openstack.block_storage.v3.volume.Volume`.
|
||||
|
||||
:returns: A :class:`~openstack.block_storage.v3.volume.Volume` with the
|
||||
volume's metadata. All keys and values are Unicode text.
|
||||
:rtype: :class:`~openstack.block_storage.v3.volume.Volume`
|
||||
"""
|
||||
volume = self._get_resource(_volume.Volume, volume)
|
||||
return volume.fetch_metadata(self)
|
||||
|
||||
def set_volume_metadata(self, volume, **metadata):
|
||||
"""Update metadata for a volume
|
||||
|
||||
:param volume: Either the ID of a volume or a
|
||||
:class:`~openstack.block_storage.v3.volume.Volume`.
|
||||
:param kwargs metadata: Key/value pairs to be updated in the volume's
|
||||
metadata. No other metadata is modified by this call. All keys
|
||||
and values are stored as Unicode.
|
||||
|
||||
:returns: A :class:`~openstack.block_storage.v3.volume.Volume` with the
|
||||
volume's metadata. All keys and values are Unicode text.
|
||||
:rtype: :class:`~openstack.block_storage.v3.volume.Volume`
|
||||
"""
|
||||
volume = self._get_resource(_volume.Volume, volume)
|
||||
return volume.set_metadata(self, metadata=metadata)
|
||||
|
||||
def delete_volume_metadata(self, volume, keys=None):
|
||||
"""Delete metadata for a volume
|
||||
|
||||
:param volume: Either the ID of a volume or a
|
||||
:class:`~openstack.block_storage.v3.volume.Volume`.
|
||||
:param list keys: The keys to delete. If left empty complete
|
||||
metadata will be removed.
|
||||
|
||||
:rtype: ``None``
|
||||
"""
|
||||
volume = self._get_resource(_volume.Volume, volume)
|
||||
if keys is not None:
|
||||
for key in keys:
|
||||
volume.delete_metadata_item(self, key)
|
||||
else:
|
||||
volume.delete_metadata(self)
|
||||
|
||||
# ====== VOLUME ACTIONS ======
|
||||
def extend_volume(self, volume, size):
|
||||
"""Extend a volume
|
||||
@ -985,6 +1082,96 @@ class Proxy(_base_proxy.BaseBlockStorageProxy):
|
||||
return self._update(
|
||||
_group_type.GroupType, group_type, **attrs)
|
||||
|
||||
# ====== QUOTA SETS ======
|
||||
def get_quota_set(self, project, usage=False, **query):
|
||||
"""Show quota set information for the project
|
||||
|
||||
:param project: ID or instance of
|
||||
:class:`~openstack.identity.project.Project` of the project for
|
||||
which the quota should be retrieved
|
||||
:param bool usage: When set to ``True`` quota usage and reservations
|
||||
would be filled.
|
||||
:param dict query: Additional query parameters to use.
|
||||
|
||||
:returns: One :class:`~openstack.block_storage.v3.quota_set.QuotaSet`
|
||||
:raises: :class:`~openstack.exceptions.ResourceNotFound`
|
||||
when no resource can be found.
|
||||
"""
|
||||
project = self._get_resource(_project.Project, project)
|
||||
res = self._get_resource(
|
||||
_quota_set.QuotaSet, None, project_id=project.id)
|
||||
return res.fetch(
|
||||
self, usage=usage, **query)
|
||||
|
||||
def get_quota_set_defaults(self, project):
|
||||
"""Show quota set defaults for the project
|
||||
|
||||
:param project: ID or instance of
|
||||
:class:`~openstack.identity.project.Project` of the project for
|
||||
which the quota should be retrieved
|
||||
|
||||
:returns: One :class:`~openstack.block_storage.v3.quota_set.QuotaSet`
|
||||
:raises: :class:`~openstack.exceptions.ResourceNotFound`
|
||||
when no resource can be found.
|
||||
"""
|
||||
project = self._get_resource(_project.Project, project)
|
||||
res = self._get_resource(
|
||||
_quota_set.QuotaSet, None, project_id=project.id)
|
||||
return res.fetch(
|
||||
self, base_path='/os-quota-sets/defaults')
|
||||
|
||||
def revert_quota_set(self, project, **query):
|
||||
"""Reset quota for the project/user.
|
||||
|
||||
:param project: ID or instance of
|
||||
:class:`~openstack.identity.project.Project` of the project for
|
||||
which the quota should be resetted.
|
||||
:param dict query: Additional parameters to be used.
|
||||
|
||||
:returns: ``None``
|
||||
"""
|
||||
project = self._get_resource(_project.Project, project)
|
||||
res = self._get_resource(
|
||||
_quota_set.QuotaSet, None, project_id=project.id)
|
||||
|
||||
if not query:
|
||||
query = {}
|
||||
return res.delete(self, **query)
|
||||
|
||||
def update_quota_set(self, quota_set, query=None, **attrs):
|
||||
"""Update a quota set.
|
||||
|
||||
:param quota_set: Either the ID of a quota_set or a
|
||||
:class:`~openstack.block_storage.v3.quota_set.QuotaSet` instance.
|
||||
:param dict query: Optional parameters to be used with update call.
|
||||
:attrs kwargs: The attributes to update on the quota set
|
||||
|
||||
:returns: The updated QuotaSet
|
||||
:rtype: :class:`~openstack.block_storage.v3.quota_set.QuotaSet`
|
||||
"""
|
||||
res = self._get_resource(_quota_set.QuotaSet, quota_set, **attrs)
|
||||
if not query:
|
||||
query = {}
|
||||
return res.commit(self, **query)
|
||||
|
||||
# ====== RESOURCE FILTERS ======
|
||||
def resource_filters(self, **query):
|
||||
"""Retrieve a generator of resource filters
|
||||
|
||||
:returns: A generator of resource filters.
|
||||
"""
|
||||
return self._list(_resource_filter.ResourceFilter, **query)
|
||||
|
||||
# ====== EXTENSIONS ======
|
||||
def extensions(self):
|
||||
"""Return a generator of extensions
|
||||
|
||||
:returns: A generator of extension
|
||||
:rtype: :class:`~openstack.block_storage.v3.extension.Extension`
|
||||
"""
|
||||
return self._list(_extension.Extension)
|
||||
|
||||
# ====== UTILS ======
|
||||
def wait_for_status(self, res, status='available', failures=None,
|
||||
interval=2, wait=120):
|
||||
"""Wait for a resource to be in a particular status.
|
||||
@ -1026,93 +1213,6 @@ class Proxy(_base_proxy.BaseBlockStorageProxy):
|
||||
"""
|
||||
return resource.wait_for_delete(self, res, interval, wait)
|
||||
|
||||
def resource_filters(self, **query):
|
||||
"""Retrieve a generator of resource filters
|
||||
|
||||
:returns: A generator of resource filters.
|
||||
"""
|
||||
return self._list(_resource_filter.ResourceFilter, **query)
|
||||
|
||||
def extensions(self):
|
||||
"""Return a generator of extensions
|
||||
|
||||
:returns: A generator of extension
|
||||
:rtype: :class:`~openstack.block_storage.v3.extension.Extension`
|
||||
"""
|
||||
return self._list(_extension.Extension)
|
||||
|
||||
def get_quota_set(self, project, usage=False, **query):
|
||||
"""Show QuotaSet information for the project
|
||||
|
||||
:param project: ID or instance of
|
||||
:class:`~openstack.identity.project.Project` of the project for
|
||||
which the quota should be retrieved
|
||||
:param bool usage: When set to ``True`` quota usage and reservations
|
||||
would be filled.
|
||||
:param dict query: Additional query parameters to use.
|
||||
|
||||
:returns: One :class:`~openstack.block_storage.v3.quota_set.QuotaSet`
|
||||
:raises: :class:`~openstack.exceptions.ResourceNotFound`
|
||||
when no resource can be found.
|
||||
"""
|
||||
project = self._get_resource(_project.Project, project)
|
||||
res = self._get_resource(
|
||||
_quota_set.QuotaSet, None, project_id=project.id)
|
||||
return res.fetch(
|
||||
self, usage=usage, **query)
|
||||
|
||||
def get_quota_set_defaults(self, project):
|
||||
"""Show QuotaSet defaults for the project
|
||||
|
||||
:param project: ID or instance of
|
||||
:class:`~openstack.identity.project.Project` of the project for
|
||||
which the quota should be retrieved
|
||||
|
||||
:returns: One :class:`~openstack.block_storage.v3.quota_set.QuotaSet`
|
||||
:raises: :class:`~openstack.exceptions.ResourceNotFound`
|
||||
when no resource can be found.
|
||||
"""
|
||||
project = self._get_resource(_project.Project, project)
|
||||
res = self._get_resource(
|
||||
_quota_set.QuotaSet, None, project_id=project.id)
|
||||
return res.fetch(
|
||||
self, base_path='/os-quota-sets/defaults')
|
||||
|
||||
def revert_quota_set(self, project, **query):
|
||||
"""Reset Quota for the project/user.
|
||||
|
||||
:param project: ID or instance of
|
||||
:class:`~openstack.identity.project.Project` of the project for
|
||||
which the quota should be resetted.
|
||||
:param dict query: Additional parameters to be used.
|
||||
|
||||
:returns: ``None``
|
||||
"""
|
||||
project = self._get_resource(_project.Project, project)
|
||||
res = self._get_resource(
|
||||
_quota_set.QuotaSet, None, project_id=project.id)
|
||||
|
||||
if not query:
|
||||
query = {}
|
||||
return res.delete(self, **query)
|
||||
|
||||
def update_quota_set(self, quota_set, query=None, **attrs):
|
||||
"""Update a QuotaSet.
|
||||
|
||||
:param quota_set: Either the ID of a quota_set or a
|
||||
:class:`~openstack.block_storage.v3.quota_set.QuotaSet` instance.
|
||||
:param dict query: Optional parameters to be used with update call.
|
||||
:attrs kwargs: The attributes to update on the QuotaSet represented
|
||||
by ``quota_set``.
|
||||
|
||||
:returns: The updated QuotaSet
|
||||
:rtype: :class:`~openstack.block_storage.v3.quota_set.QuotaSet`
|
||||
"""
|
||||
res = self._get_resource(_quota_set.QuotaSet, quota_set, **attrs)
|
||||
if not query:
|
||||
query = {}
|
||||
return res.commit(self, **query)
|
||||
|
||||
def _get_cleanup_dependencies(self):
|
||||
return {
|
||||
'block_storage': {
|
||||
@ -1174,97 +1274,3 @@ class Proxy(_base_proxy.BaseBlockStorageProxy):
|
||||
identified_resources=identified_resources,
|
||||
filters=filters,
|
||||
resource_evaluation_fn=resource_evaluation_fn)
|
||||
|
||||
def get_volume_metadata(self, volume):
|
||||
"""Return a dictionary of metadata for a volume
|
||||
|
||||
:param volume: Either the ID of a volume or a
|
||||
:class:`~openstack.block_storage.v3.volume.Volume`.
|
||||
|
||||
:returns: A :class:`~openstack.block_storage.v3.volume.Volume` with the
|
||||
volume's metadata. All keys and values are Unicode text.
|
||||
:rtype: :class:`~openstack.block_storage.v3.volume.Volume`
|
||||
"""
|
||||
volume = self._get_resource(_volume.Volume, volume)
|
||||
return volume.fetch_metadata(self)
|
||||
|
||||
def set_volume_metadata(self, volume, **metadata):
|
||||
"""Update metadata for a volume
|
||||
|
||||
:param volume: Either the ID of a volume or a
|
||||
:class:`~openstack.block_storage.v3.volume.Volume`.
|
||||
:param kwargs metadata: Key/value pairs to be updated in the volume's
|
||||
metadata. No other metadata is modified by this call. All keys
|
||||
and values are stored as Unicode.
|
||||
|
||||
:returns: A :class:`~openstack.block_storage.v3.volume.Volume` with the
|
||||
volume's metadata. All keys and values are Unicode text.
|
||||
:rtype: :class:`~openstack.block_storage.v3.volume.Volume`
|
||||
"""
|
||||
volume = self._get_resource(_volume.Volume, volume)
|
||||
return volume.set_metadata(self, metadata=metadata)
|
||||
|
||||
def delete_volume_metadata(self, volume, keys=None):
|
||||
"""Delete metadata for a volume
|
||||
|
||||
:param volume: Either the ID of a volume or a
|
||||
:class:`~openstack.block_storage.v3.volume.Volume`.
|
||||
:param list keys: The keys to delete. If left empty complete
|
||||
metadata will be removed.
|
||||
|
||||
:rtype: ``None``
|
||||
"""
|
||||
volume = self._get_resource(_volume.Volume, volume)
|
||||
if keys is not None:
|
||||
for key in keys:
|
||||
volume.delete_metadata_item(self, key)
|
||||
else:
|
||||
volume.delete_metadata(self)
|
||||
|
||||
def get_snapshot_metadata(self, snapshot):
|
||||
"""Return a dictionary of metadata for a snapshot
|
||||
|
||||
:param snapshot: Either the ID of a snapshot or a
|
||||
:class:`~openstack.block_storage.v3.snapshot.Snapshot`.
|
||||
|
||||
:returns: A
|
||||
:class:`~openstack.block_storage.v3.snapshot.Snapshot` with the
|
||||
snapshot's metadata. All keys and values are Unicode text.
|
||||
:rtype: :class:`~openstack.block_storage.v3.snapshot.Snapshot`
|
||||
"""
|
||||
snapshot = self._get_resource(_snapshot.Snapshot, snapshot)
|
||||
return snapshot.fetch_metadata(self)
|
||||
|
||||
def set_snapshot_metadata(self, snapshot, **metadata):
|
||||
"""Update metadata for a snapshot
|
||||
|
||||
:param snapshot: Either the ID of a snapshot or a
|
||||
:class:`~openstack.block_storage.v3.snapshot.Snapshot`.
|
||||
:param kwargs metadata: Key/value pairs to be updated in the snapshot's
|
||||
metadata. No other metadata is modified by this call. All keys
|
||||
and values are stored as Unicode.
|
||||
|
||||
:returns: A
|
||||
:class:`~openstack.block_storage.v3.snapshot.Snapshot` with the
|
||||
snapshot's metadata. All keys and values are Unicode text.
|
||||
:rtype: :class:`~openstack.block_storage.v3.snapshot.Snapshot`
|
||||
"""
|
||||
snapshot = self._get_resource(_snapshot.Snapshot, snapshot)
|
||||
return snapshot.set_metadata(self, metadata=metadata)
|
||||
|
||||
def delete_snapshot_metadata(self, snapshot, keys=None):
|
||||
"""Delete metadata for a snapshot
|
||||
|
||||
:param snapshot: Either the ID of a snapshot or a
|
||||
:class:`~openstack.block_storage.v3.snapshot.Snapshot`.
|
||||
:param list keys: The keys to delete. If left empty complete
|
||||
metadata will be removed.
|
||||
|
||||
:rtype: ``None``
|
||||
"""
|
||||
snapshot = self._get_resource(_snapshot.Snapshot, snapshot)
|
||||
if keys is not None:
|
||||
for key in keys:
|
||||
snapshot.delete_metadata_item(self, key)
|
||||
else:
|
||||
snapshot.delete_metadata(self)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user