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
|
# Copyright (C) 2016 EMC Corporation.
# All Rights Reserved.
#
# 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 snapshot interface (v3)."""
from cinderclient import api_versions
from cinderclient.apiclient import base as common_base
from cinderclient import base
from cinderclient import utils
class GroupSnapshot(base.Resource):
"""A group snapshot is a snapshot of a group."""
def __repr__(self):
return "<group_snapshot: %s>" % self.id
def delete(self):
"""Delete this group snapshot."""
return self.manager.delete(self)
def update(self, **kwargs):
"""Update the name or description for this group snapshot."""
return self.manager.update(self, **kwargs)
def reset_state(self, state):
"""Reset the group snapshot's state with specified one."""
return self.manager.reset_state(self, state)
class GroupSnapshotManager(base.ManagerWithFind):
"""Manage :class:`GroupSnapshot` resources."""
resource_class = GroupSnapshot
@api_versions.wraps('3.14')
def create(self, group_id, name=None, description=None,
user_id=None,
project_id=None):
"""Creates a group snapshot.
:param group_id: Name or uuid of a group
:param name: Name of the group snapshot
:param description: Description of the group snapshot
:param user_id: User id derived from context
:param project_id: Project id derived from context
:rtype: :class:`GroupSnapshot`
"""
body = {
'group_snapshot': {
'group_id': group_id,
'name': name,
'description': description,
}
}
return self._create('/group_snapshots', body, 'group_snapshot')
@api_versions.wraps('3.14')
def get(self, group_snapshot_id):
"""Get a group snapshot.
:param group_snapshot_id: The ID of the group snapshot to get.
:rtype: :class:`GroupSnapshot`
"""
return self._get("/group_snapshots/%s" % group_snapshot_id,
"group_snapshot")
@api_versions.wraps('3.19')
def reset_state(self, group_snapshot, state):
"""Update the provided group snapshot with the provided state.
:param group_snapshot: The :class:`GroupSnapshot` to set the state.
:param state: The state of the group snapshot to be set.
"""
body = {'status': state} if state else {}
return self._action('reset_status', group_snapshot, body)
@api_versions.wraps('3.14')
def list(self, detailed=True, search_opts=None):
"""Lists all group snapshots.
:param detailed: list detailed info or not
:param search_opts: search options
:rtype: list of :class:`GroupSnapshot`
"""
query_string = utils.build_query_param(search_opts, sort=True)
detail = ""
if detailed:
detail = "/detail"
return self._list("/group_snapshots%s%s" % (detail, query_string),
"group_snapshots")
@api_versions.wraps('3.14')
def delete(self, group_snapshot):
"""Delete a group_snapshot.
:param group_snapshot: The :class:`GroupSnapshot` to delete.
"""
return self._delete("/group_snapshots/%s" % base.getid(group_snapshot))
@api_versions.wraps('3.14')
def update(self, group_snapshot, **kwargs):
"""Update the name or description for a group_snapshot.
:param group_snapshot: The :class:`GroupSnapshot` to update.
"""
if not kwargs:
return
body = {"group_snapshot": kwargs}
return self._update("/group_snapshots/%s" % base.getid(group_snapshot),
body)
def _action(self, action, group_snapshot, info=None, **kwargs):
"""Perform a group_snapshot action."""
body = {action: info}
self.run_hooks('modify_body_for_action', body, **kwargs)
url = '/group_snapshots/%s/action' % base.getid(group_snapshot)
resp, body = self.api.client.post(url, body=body)
return common_base.TupleWithMeta((resp, body), resp)
|
