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
|
# 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.
import typing as ty
import typing_extensions as ty_ext
from openstack import exceptions
from openstack import resource
from openstack import utils
class MetadataMixin:
id: str
base_path: str
_body: resource._ComponentManager
#: *Type: list of tag strings*
metadata = resource.Body('metadata', type=dict)
def fetch_metadata(self, session: resource.AdapterT) -> ty_ext.Self:
"""Lists metadata set on the entity.
:param session: The session to use for making this request.
:return: The dictionary with metadata attached to the entity
"""
url = utils.urljoin(self.base_path, self.id, 'metadata')
response = session.get(url)
exceptions.raise_from_response(response)
json = response.json()
if 'metadata' in json:
self._body.attributes.update({'metadata': json['metadata']})
return self
def set_metadata(
self,
session: resource.AdapterT,
metadata: dict[str, ty.Any] | None = None,
replace: bool = False,
) -> ty_ext.Self:
"""Sets/Replaces metadata key value pairs on the resource.
:param session: The session to use for making this request.
:param dict metadata: Dictionary with key-value pairs
:param bool replace: Replace all resource metadata with the new object
or merge new and existing.
"""
url = utils.urljoin(self.base_path, self.id, 'metadata')
if not metadata:
metadata = {}
if not replace:
response = session.post(url, json={'metadata': metadata})
else:
response = session.put(url, json={'metadata': metadata})
exceptions.raise_from_response(response)
self._body.attributes.update({'metadata': metadata})
return self
def replace_metadata(
self,
session: resource.AdapterT,
metadata: dict[str, ty.Any] | None = None,
) -> ty_ext.Self:
"""Replaces all metadata key value pairs on the resource.
:param session: The session to use for making this request.
:param dict metadata: Dictionary with key-value pairs
:param bool replace: Replace all resource metadata with the new object
or merge new and existing.
"""
return self.set_metadata(session, metadata, replace=True)
def delete_metadata(self, session: resource.AdapterT) -> ty_ext.Self:
"""Removes all metadata on the entity.
:param session: The session to use for making this request.
"""
self.set_metadata(session, None, replace=True)
return self
def get_metadata_item(
self, session: resource.AdapterT, key: str
) -> ty_ext.Self:
"""Get the single metadata item on the entity.
If the metadata key does not exist a 404 will be returned
:param session: The session to use for making this request.
:param str key: The key of a metadata item.
"""
url = utils.urljoin(self.base_path, self.id, 'metadata', key)
response = session.get(url)
exceptions.raise_from_response(
response, error_message='Metadata item does not exist'
)
meta = response.json().get('meta', {})
# Here we need to potentially init metadata
metadata = self.metadata or {}
metadata[key] = meta.get(key)
self._body.attributes.update({'metadata': metadata})
return self
def set_metadata_item(
self, session: resource.AdapterT, key: str, value: ty.Any
) -> ty_ext.Self:
"""Create or replace single metadata item to the resource.
:param session: The session to use for making this request.
:param str key: The key for the metadata item.
:param str value: The value.
"""
url = utils.urljoin(self.base_path, self.id, 'metadata', key)
response = session.put(url, json={'meta': {key: value}})
exceptions.raise_from_response(response)
# we do not want to update tags directly
metadata = self.metadata
metadata[key] = value
self._body.attributes.update({'metadata': metadata})
return self
def delete_metadata_item(
self, session: resource.AdapterT, key: str
) -> ty_ext.Self:
"""Removes a single metadata item from the specified resource.
:param session: The session to use for making this request.
:param str key: The key as a string.
"""
url = utils.urljoin(self.base_path, self.id, 'metadata', key)
response = session.delete(url)
exceptions.raise_from_response(response)
# we do not want to update tags directly
metadata = self.metadata
try:
if metadata:
metadata.pop(key)
else:
metadata = {}
except ValueError:
pass # do nothing!
self._body.attributes.update({'metadata': metadata})
return self
|
