python-manilaclient/manilaclient/v2/share_access_rules.py
Goutham Pacha Ravi c7b1c6a1d3 Refactor code from oslo_incubator
At some point, common code for this project
originated in the oslo_incubator project; and
we performed a final sync of this code in 2014 [1].

However, this sync'ed code was unused; so lets
delete this code and consolidate common code for
ease of use.

[1] https://review.opendev.org/c/openstack/python-manilaclient/+/98088

Change-Id: Ifd9c7516aab8e3c2d017a1ce421d2e65e76d5640
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2022-01-21 19:47:04 +00:00

90 lines
2.9 KiB
Python

# Copyright 2018 Huawei Corporation.
# All Rights Reserved.
#
# Copyright 2018
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Interface for share access rules extension."""
from manilaclient import api_versions
from manilaclient import base
RESOURCE_PATH = '/share-access-rules/%s'
RESOURCE_NAME = 'access'
RESOURCES_METADATA_PATH = '/share-access-rules/%s/metadata'
RESOURCE_METADATA_PATH = '/share-access-rules/%s/metadata/%s'
RESOURCE_LIST_PATH = '/share-access-rules'
class ShareAccessRule(base.Resource):
"""A Share Access Rule."""
def __repr__(self):
return "<Share Access Rule: %s>" % self.id
def delete(self):
""""Delete this share access rule."""
self.manager.delete(self)
class ShareAccessRuleManager(base.ManagerWithFind):
"""Manage :class:`ShareAccessRule` resources."""
resource_class = ShareAccessRule
@api_versions.wraps("2.45")
def get(self, share_access_rule):
"""Get a specific share access rule.
:param share_access_rule: either instance of ShareAccessRule, or text
with UUID
:rtype: :class:`ShareAccessRule`
"""
share_access_rule_id = base.getid(share_access_rule)
url = RESOURCE_PATH % share_access_rule_id
return self._get(url, RESOURCE_NAME)
@api_versions.wraps("2.45")
def set_metadata(self, access, metadata):
"""Set or update metadata for share access rule.
:param share_access_rule: either share access rule object or
text with its ID.
:param metadata: A list of keys to be set.
"""
body = {'metadata': metadata}
access_id = base.getid(access)
url = RESOURCES_METADATA_PATH % access_id
return self._update(url, body, "metadata")
@api_versions.wraps("2.45")
def unset_metadata(self, access, keys):
"""Unset metadata on a share access rule.
:param keys: A list of keys on this object to be unset
:return: None if successful, else API response on failure
"""
for k in keys:
url = RESOURCE_METADATA_PATH % (base.getid(access), k)
self._delete(url)
@api_versions.wraps("2.45")
def access_list(self, share, search_opts=None):
search_opts = search_opts or {}
search_opts['share_id'] = base.getid(share)
query_string = self._build_query_string(search_opts)
url = RESOURCE_LIST_PATH + query_string
return self._list(url, 'access_list')