xautomata-hive 3.19.1__py3-none-any.whl → 3.20.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,320 @@
1
+ from hive.api import ApiManager, handling_single_page_methods, warning_wrong_parameters
2
+
3
+
4
+ class TreeHierarchyV2(ApiManager):
5
+ """Class that handles all the XAutomata tree_hierarchy_v2 APIs"""
6
+
7
+ def tree_hierarchy_v2_groups(self, warm_start: bool = False,
8
+ single_page: bool = False, page_size: int = 5000,
9
+ kwargs: dict = None, **params) -> list:
10
+ """Tree Hierarchy Groups
11
+
12
+ Args:
13
+ warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
14
+ single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
15
+ page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
16
+ kwargs (dict, optional): additional parameters for execute. Default to None.
17
+ **params: additional parameters for the API.
18
+
19
+ Keyword Args:
20
+ extract_severity (boolean optional): Se True nella risposta e' anche presente la severita, Default to False. - parameter
21
+ sort_by (string optional): Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
22
+ null_fields (string optional): additional filter - parameter
23
+ uuid_customer (string optional): additional filter - parameter
24
+ customer_code (string optional): additional filter - parameter
25
+ customer_status (string optional): additional filter - parameter
26
+ uuid_site (string optional): additional filter - parameter
27
+ site_code (string optional): additional filter - parameter
28
+ site_description (string optional): additional filter - parameter
29
+ site_address (string optional): additional filter - parameter
30
+ site_zip_code (string optional): additional filter - parameter
31
+ site_city (string optional): additional filter - parameter
32
+ site_country (string optional): additional filter - parameter
33
+ site_state_province (string optional): additional filter - parameter
34
+ site_status (string optional): additional filter - parameter
35
+ site_type (string optional): additional filter - parameter
36
+ uuid_group (string optional): additional filter - parameter
37
+ group_name (string optional): additional filter - parameter
38
+ group_status (string optional): additional filter - parameter
39
+ group_type (string optional): additional filter - parameter
40
+ uuid_virtual_domain (string optional): additional filter - parameter
41
+ virtual_domain_name (string optional): additional filter - parameter
42
+ skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
43
+ limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
44
+ like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
45
+ join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
46
+ count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter
47
+
48
+ Returns: list"""
49
+ if kwargs is None:
50
+ kwargs = dict()
51
+ official_params_list = ['extract_severity', 'sort_by',
52
+ 'null_fields', 'uuid_customer', 'customer_code',
53
+ 'customer_status', 'uuid_site', 'site_code', 'site_description',
54
+ 'site_address', 'site_zip_code', 'site_city', 'site_country',
55
+ 'site_state_province', 'site_status', 'site_type', 'uuid_group',
56
+ 'group_name', 'group_status', 'group_type',
57
+ 'uuid_virtual_domain', 'virtual_domain_name', 'skip', 'limit',
58
+ 'like', 'join', 'count']
59
+ params.get('extract_severity'), params.get('sort_by'), params.get(
60
+ 'null_fields'), params.get('uuid_customer'), params.get(
61
+ 'customer_code'), params.get('customer_status'), params.get(
62
+ 'uuid_site'), params.get('site_code'), params.get(
63
+ 'site_description'), params.get('site_address'), params.get(
64
+ 'site_zip_code'), params.get('site_city'), params.get(
65
+ 'site_country'), params.get('site_state_province'), params.get(
66
+ 'site_status'), params.get('site_type'), params.get('uuid_group'
67
+ ), params.get('group_name'), params.get('group_status'
68
+ ), params.get('group_type'), params.get('uuid_virtual_domain'
69
+ ), params.get('virtual_domain_name'), params.get('skip'
70
+ ), params.get('limit'), params.get('like'), params.get('join'
71
+ ), params.get('count')
72
+ if not self._silence_warning:
73
+ warning_wrong_parameters(self.tree_hierarchy_v2_groups.__name__,
74
+ params, official_params_list)
75
+ response = self.execute('GET', path=f'/tree_hierarchy_v2/groups',
76
+ single_page=single_page, page_size=page_size, warm_start=
77
+ warm_start, params=params, **kwargs)
78
+ return response
79
+
80
+ def tree_hierarchy_v2_objects(self, warm_start: bool = False,
81
+ single_page: bool = False, page_size: int = 5000,
82
+ kwargs: dict = None, **params) -> list:
83
+ """Tree Hierarchy Objects
84
+
85
+ Args:
86
+ warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
87
+ single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
88
+ page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
89
+ kwargs (dict, optional): additional parameters for execute. Default to None.
90
+ **params: additional parameters for the API.
91
+
92
+ Keyword Args:
93
+ sort_by (string optional): Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
94
+ null_fields (string optional): additional filter - parameter
95
+ extract_data_profile (boolean optional): additional filter - parameter
96
+ extract_severity (boolean optional): Se True nella risposta e' anche presente la severita, Default to False. - parameter
97
+ extract_ip_cidr (boolean optional): additional filter - parameter
98
+ uuid_customer (string optional): additional filter - parameter
99
+ customer_code (string optional): additional filter - parameter
100
+ customer_status (string optional): additional filter - parameter
101
+ uuid_site (string optional): additional filter - parameter
102
+ site_code (string optional): additional filter - parameter
103
+ site_description (string optional): additional filter - parameter
104
+ site_address (string optional): additional filter - parameter
105
+ site_zip_code (string optional): additional filter - parameter
106
+ site_city (string optional): additional filter - parameter
107
+ site_country (string optional): additional filter - parameter
108
+ site_state_province (string optional): additional filter - parameter
109
+ site_status (string optional): additional filter - parameter
110
+ uuid_group (string optional): additional filter - parameter
111
+ group_name (string optional): additional filter - parameter
112
+ group_status (string optional): additional filter - parameter
113
+ group_type (string optional): additional filter - parameter
114
+ uuid_object (string optional): additional filter - parameter
115
+ object_name (string optional): additional filter - parameter
116
+ object_status (string optional): additional filter - parameter
117
+ object_profile (string optional): additional filter - parameter
118
+ uuid_virtual_domain (string optional): additional filter - parameter
119
+ virtual_domain_name (string optional): additional filter - parameter
120
+ skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
121
+ limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
122
+ like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
123
+ join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
124
+ count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter
125
+
126
+ Returns: list"""
127
+ if kwargs is None:
128
+ kwargs = dict()
129
+ official_params_list = ['sort_by', 'null_fields',
130
+ 'extract_data_profile', 'extract_severity', 'extract_ip_cidr',
131
+ 'uuid_customer', 'customer_code', 'customer_status',
132
+ 'uuid_site', 'site_code', 'site_description', 'site_address',
133
+ 'site_zip_code', 'site_city', 'site_country',
134
+ 'site_state_province', 'site_status', 'uuid_group',
135
+ 'group_name', 'group_status', 'group_type', 'uuid_object',
136
+ 'object_name', 'object_status', 'object_profile',
137
+ 'uuid_virtual_domain', 'virtual_domain_name', 'skip', 'limit',
138
+ 'like', 'join', 'count']
139
+ params.get('sort_by'), params.get('null_fields'), params.get(
140
+ 'extract_data_profile'), params.get('extract_severity'
141
+ ), params.get('extract_ip_cidr'), params.get('uuid_customer'
142
+ ), params.get('customer_code'), params.get('customer_status'
143
+ ), params.get('uuid_site'), params.get('site_code'), params.get(
144
+ 'site_description'), params.get('site_address'), params.get(
145
+ 'site_zip_code'), params.get('site_city'), params.get(
146
+ 'site_country'), params.get('site_state_province'), params.get(
147
+ 'site_status'), params.get('uuid_group'), params.get('group_name'
148
+ ), params.get('group_status'), params.get('group_type'
149
+ ), params.get('uuid_object'), params.get('object_name'
150
+ ), params.get('object_status'), params.get('object_profile'
151
+ ), params.get('uuid_virtual_domain'), params.get(
152
+ 'virtual_domain_name'), params.get('skip'), params.get('limit'
153
+ ), params.get('like'), params.get('join'), params.get('count')
154
+ if not self._silence_warning:
155
+ warning_wrong_parameters(self.tree_hierarchy_v2_objects.
156
+ __name__, params, official_params_list)
157
+ response = self.execute('GET', path=f'/tree_hierarchy_v2/objects',
158
+ single_page=single_page, page_size=page_size, warm_start=
159
+ warm_start, params=params, **kwargs)
160
+ return response
161
+
162
+ def tree_hierarchy_v2_metric_types(self, warm_start: bool = False,
163
+ single_page: bool = False, page_size: int = 5000,
164
+ kwargs: dict = None, **params) -> list:
165
+ """Tree Hierarchy Metric Types
166
+
167
+ Args:
168
+ warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
169
+ single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
170
+ page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
171
+ kwargs (dict, optional): additional parameters for execute. Default to None.
172
+ **params: additional parameters for the API.
173
+
174
+ Keyword Args:
175
+ sort_by (string optional): Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
176
+ null_fields (string optional): additional filter - parameter
177
+ uuid_customer (string optional): additional filter - parameter
178
+ customer_code (string optional): additional filter - parameter
179
+ customer_status (string optional): additional filter - parameter
180
+ uuid_site (string optional): additional filter - parameter
181
+ site_code (string optional): additional filter - parameter
182
+ site_description (string optional): additional filter - parameter
183
+ site_address (string optional): additional filter - parameter
184
+ site_zip_code (string optional): additional filter - parameter
185
+ site_city (string optional): additional filter - parameter
186
+ site_country (string optional): additional filter - parameter
187
+ site_state_province (string optional): additional filter - parameter
188
+ site_status (string optional): additional filter - parameter
189
+ uuid_group (string optional): additional filter - parameter
190
+ group_name (string optional): additional filter - parameter
191
+ group_status (string optional): additional filter - parameter
192
+ group_type (string optional): additional filter - parameter
193
+ uuid_object (string optional): additional filter - parameter
194
+ object_name (string optional): additional filter - parameter
195
+ object_status (string optional): additional filter - parameter
196
+ object_profile (string optional): additional filter - parameter
197
+ metric_type_name (string optional): additional filter - parameter
198
+ metric_type_status (string optional): additional filter - parameter
199
+ metric_type_profile (string optional): additional filter - parameter
200
+ skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
201
+ limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
202
+ like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
203
+ join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
204
+ count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter
205
+
206
+ Returns: list"""
207
+ if kwargs is None:
208
+ kwargs = dict()
209
+ official_params_list = ['sort_by', 'null_fields', 'uuid_customer',
210
+ 'customer_code', 'customer_status', 'uuid_site', 'site_code',
211
+ 'site_description', 'site_address', 'site_zip_code',
212
+ 'site_city', 'site_country', 'site_state_province',
213
+ 'site_status', 'uuid_group', 'group_name', 'group_status',
214
+ 'group_type', 'uuid_object', 'object_name', 'object_status',
215
+ 'object_profile', 'metric_type_name', 'metric_type_status',
216
+ 'metric_type_profile', 'skip', 'limit', 'like', 'join', 'count']
217
+ params.get('sort_by'), params.get('null_fields'), params.get(
218
+ 'uuid_customer'), params.get('customer_code'), params.get(
219
+ 'customer_status'), params.get('uuid_site'), params.get('site_code'
220
+ ), params.get('site_description'), params.get('site_address'
221
+ ), params.get('site_zip_code'), params.get('site_city'
222
+ ), params.get('site_country'), params.get('site_state_province'
223
+ ), params.get('site_status'), params.get('uuid_group'), params.get(
224
+ 'group_name'), params.get('group_status'), params.get('group_type'
225
+ ), params.get('uuid_object'), params.get('object_name'
226
+ ), params.get('object_status'), params.get('object_profile'
227
+ ), params.get('metric_type_name'), params.get('metric_type_status'
228
+ ), params.get('metric_type_profile'), params.get('skip'
229
+ ), params.get('limit'), params.get('like'), params.get('join'
230
+ ), params.get('count')
231
+ if not self._silence_warning:
232
+ warning_wrong_parameters(self.tree_hierarchy_v2_metric_types.
233
+ __name__, params, official_params_list)
234
+ response = self.execute('GET', path=
235
+ f'/tree_hierarchy_v2/metric_types', single_page=single_page,
236
+ page_size=page_size, warm_start=warm_start, params=params, **kwargs
237
+ )
238
+ return response
239
+
240
+ def tree_hierarchy_v2_metrics(self, warm_start: bool = False,
241
+ single_page: bool = False, page_size: int = 5000,
242
+ kwargs: dict = None, **params) -> list:
243
+ """Tree Hierarchy Metrics
244
+
245
+ Args:
246
+ warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
247
+ single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
248
+ page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
249
+ kwargs (dict, optional): additional parameters for execute. Default to None.
250
+ **params: additional parameters for the API.
251
+
252
+ Keyword Args:
253
+ sort_by (string optional): Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
254
+ null_fields (string optional): additional filter - parameter
255
+ uuid_customer (string optional): additional filter - parameter
256
+ customer_code (string optional): additional filter - parameter
257
+ customer_status (string optional): additional filter - parameter
258
+ uuid_site (string optional): additional filter - parameter
259
+ site_code (string optional): additional filter - parameter
260
+ site_description (string optional): additional filter - parameter
261
+ site_address (string optional): additional filter - parameter
262
+ site_zip_code (string optional): additional filter - parameter
263
+ site_city (string optional): additional filter - parameter
264
+ site_country (string optional): additional filter - parameter
265
+ site_state_province (string optional): additional filter - parameter
266
+ site_status (string optional): additional filter - parameter
267
+ uuid_group (string optional): additional filter - parameter
268
+ group_name (string optional): additional filter - parameter
269
+ group_status (string optional): additional filter - parameter
270
+ group_type (string optional): additional filter - parameter
271
+ uuid_object (string optional): additional filter - parameter
272
+ object_name (string optional): additional filter - parameter
273
+ object_status (string optional): additional filter - parameter
274
+ object_profile (string optional): additional filter - parameter
275
+ metric_type_name (string optional): additional filter - parameter
276
+ metric_type_status (string optional): additional filter - parameter
277
+ uuid_metric (string optional): additional filter - parameter
278
+ metric_name (string optional): additional filter - parameter
279
+ metric_status (string optional): additional filter - parameter
280
+ metric_profile (string optional): additional filter - parameter
281
+ skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
282
+ limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
283
+ like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
284
+ join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
285
+ count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter
286
+
287
+ Returns: list"""
288
+ if kwargs is None:
289
+ kwargs = dict()
290
+ official_params_list = ['sort_by', 'null_fields', 'uuid_customer',
291
+ 'customer_code', 'customer_status', 'uuid_site', 'site_code',
292
+ 'site_description', 'site_address', 'site_zip_code',
293
+ 'site_city', 'site_country', 'site_state_province',
294
+ 'site_status', 'uuid_group', 'group_name', 'group_status',
295
+ 'group_type', 'uuid_object', 'object_name', 'object_status',
296
+ 'object_profile', 'metric_type_name', 'metric_type_status',
297
+ 'uuid_metric', 'metric_name', 'metric_status', 'metric_profile',
298
+ 'skip', 'limit', 'like', 'join', 'count']
299
+ params.get('sort_by'), params.get('null_fields'), params.get(
300
+ 'uuid_customer'), params.get('customer_code'), params.get(
301
+ 'customer_status'), params.get('uuid_site'), params.get('site_code'
302
+ ), params.get('site_description'), params.get('site_address'
303
+ ), params.get('site_zip_code'), params.get('site_city'
304
+ ), params.get('site_country'), params.get('site_state_province'
305
+ ), params.get('site_status'), params.get('uuid_group'), params.get(
306
+ 'group_name'), params.get('group_status'), params.get('group_type'
307
+ ), params.get('uuid_object'), params.get('object_name'
308
+ ), params.get('object_status'), params.get('object_profile'
309
+ ), params.get('metric_type_name'), params.get('metric_type_status'
310
+ ), params.get('uuid_metric'), params.get('metric_name'
311
+ ), params.get('metric_status'), params.get('metric_profile'
312
+ ), params.get('skip'), params.get('limit'), params.get('like'
313
+ ), params.get('join'), params.get('count')
314
+ if not self._silence_warning:
315
+ warning_wrong_parameters(self.tree_hierarchy_v2_metrics.
316
+ __name__, params, official_params_list)
317
+ response = self.execute('GET', path=f'/tree_hierarchy_v2/metrics',
318
+ single_page=single_page, page_size=page_size, warm_start=
319
+ warm_start, params=params, **kwargs)
320
+ return response
@@ -152,8 +152,8 @@ class TsCostManagement(ApiManager):
152
152
  Keyword Args:
153
153
  sort_by (string optional): Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
154
154
  null_fields (string optional): additional filter - parameter
155
- date_start (string optional): additional filter - parameter
156
- date_end (string optional): additional filter - parameter
155
+ date_start (string required): additional filter - parameter
156
+ date_end (string required): additional filter - parameter
157
157
  cloud_provider (string optional): additional filter - parameter
158
158
  resource_group (string optional): additional filter - parameter
159
159
  resource_location (string optional): additional filter - parameter