1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
# Copyright (c) 2016 EMC Corporation
#
# 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.
"""Group Type interface."""
from cinderclient import api_versions
from cinderclient import base
class GroupType(base.Resource):
"""A Group Type is the type of group to be created."""
def __repr__(self):
return "<GroupType: %s>" % self.name
@property
def is_public(self):
"""
Provide a user-friendly accessor to is_public
"""
return self._info.get("is_public",
self._info.get("is_public", 'N/A'))
@api_versions.wraps("3.11")
def get_keys(self):
"""Get group specs from a group type.
:param type: The :class:`GroupType` to get specs from
"""
_resp, body = self.manager.api.client.get(
"/group_types/%s/group_specs" %
base.getid(self))
return body["group_specs"]
@api_versions.wraps("3.11")
def set_keys(self, metadata):
"""Set group specs on a group type.
:param type : The :class:`GroupType` to set spec on
:param metadata: A dict of key/value pairs to be set
"""
body = {'group_specs': metadata}
return self.manager._create(
"/group_types/%s/group_specs" % base.getid(self),
body,
"group_specs",
return_raw=True)
@api_versions.wraps("3.11")
def unset_keys(self, keys):
"""Unset specs on a group type.
:param type_id: The :class:`GroupType` to unset spec on
:param keys: A list of keys to be unset
"""
for k in keys:
resp = self.manager._delete(
"/group_types/%s/group_specs/%s" % (
base.getid(self), k))
if resp:
return resp
class GroupTypeManager(base.ManagerWithFind):
"""Manage :class:`GroupType` resources."""
resource_class = GroupType
@api_versions.wraps("3.11")
def list(self, search_opts=None, is_public=None):
"""Lists all group types.
:rtype: list of :class:`GroupType`.
"""
query_string = ''
if not is_public:
query_string = '?is_public=%s' % is_public
return self._list("/group_types%s" % (query_string), "group_types")
@api_versions.wraps("3.11")
def get(self, group_type):
"""Get a specific group type.
:param group_type: The ID of the :class:`GroupType` to get.
:rtype: :class:`GroupType`
"""
return self._get("/group_types/%s" % base.getid(group_type),
"group_type")
@api_versions.wraps("3.11")
def default(self):
"""Get the default group type.
:rtype: :class:`GroupType`
"""
return self._get("/group_types/default", "group_type")
@api_versions.wraps("3.11")
def delete(self, group_type):
"""Deletes a specific group_type.
:param group_type: The name or ID of the :class:`GroupType` to get.
"""
return self._delete("/group_types/%s" % base.getid(group_type))
@api_versions.wraps("3.11")
def create(self, name, description=None, is_public=True):
"""Creates a group type.
:param name: Descriptive name of the group type
:param description: Description of the the group type
:param is_public: Group type visibility
:rtype: :class:`GroupType`
"""
body = {
"group_type": {
"name": name,
"description": description,
"is_public": is_public,
}
}
return self._create("/group_types", body, "group_type")
@api_versions.wraps("3.11")
def update(self, group_type, name=None, description=None, is_public=None):
"""Update the name and/or description for a group type.
:param group_type: The ID of the :class:`GroupType` to update.
:param name: Descriptive name of the group type.
:param description: Description of the the group type.
:rtype: :class:`GroupType`
"""
body = {
"group_type": {
"name": name,
"description": description
}
}
if is_public is not None:
body["group_type"]["is_public"] = is_public
return self._update("/group_types/%s" % base.getid(group_type),
body, response_key="group_type")
|
