Skip to content

Hive.cookbook.tree hierarchy

TreeHierarchy

Bases: ApiManager

Class that handles all the XAutomata tree_hierarchy APIs

Source code in hive/cookbook/tree_hierarchy.py 
  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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
class TreeHierarchy(ApiManager):
    """Class that handles all the XAutomata tree_hierarchy APIs"""

    def tree_hierarchy_groups(self, warm_start: bool = False,
        single_page: bool = False, page_size: int = 5000,
        kwargs: dict = None, **params) -> list:
        """Tree Hierarchy Groups

        Args:
            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.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            extract_severity (boolean optional): Se True nella risposta e' anche presente la severita, Default to False. - parameter
            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
            null_fields (string optional): additional filter - parameter
            uuid_customer (string optional): additional filter - parameter
            customer_code (string optional): additional filter - parameter
            customer_status (string optional): additional filter - parameter
            uuid_site (string optional): additional filter - parameter
            site_code (string optional): additional filter - parameter
            site_description (string optional): additional filter - parameter
            site_address (string optional): additional filter - parameter
            site_zip_code (string optional): additional filter - parameter
            site_city (string optional): additional filter - parameter
            site_country (string optional): additional filter - parameter
            site_state_province (string optional): additional filter - parameter
            site_status (string optional): additional filter - parameter
            site_type (string optional): additional filter - parameter
            uuid_group (string optional): additional filter - parameter
            group_name (string optional): additional filter - parameter
            group_status (string optional): additional filter - parameter
            group_type (string optional): additional filter - parameter
            uuid_virtual_domain (string optional): additional filter - parameter
            virtual_domain_name (string optional): additional filter - parameter
            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
            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
            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
            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

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['extract_severity', 'sort_by',
            'null_fields', 'uuid_customer', 'customer_code',
            'customer_status', 'uuid_site', 'site_code', 'site_description',
            'site_address', 'site_zip_code', 'site_city', 'site_country',
            'site_state_province', 'site_status', 'site_type', 'uuid_group',
            'group_name', 'group_status', 'group_type',
            'uuid_virtual_domain', 'virtual_domain_name', 'skip', 'limit',
            'like', 'join', 'count']
        params.get('extract_severity'), params.get('sort_by'), params.get(
            'null_fields'), params.get('uuid_customer'), params.get(
            'customer_code'), params.get('customer_status'), params.get(
            'uuid_site'), params.get('site_code'), params.get(
            'site_description'), params.get('site_address'), params.get(
            'site_zip_code'), params.get('site_city'), params.get(
            'site_country'), params.get('site_state_province'), params.get(
            'site_status'), params.get('site_type'), params.get('uuid_group'
            ), params.get('group_name'), params.get('group_status'
            ), params.get('group_type'), params.get('uuid_virtual_domain'
            ), params.get('virtual_domain_name'), params.get('skip'
            ), params.get('limit'), params.get('like'), params.get('join'
            ), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.tree_hierarchy_groups.__name__,
                params, official_params_list)
        response = self.execute('GET', path=f'/tree_hierarchy/groups',
            single_page=single_page, page_size=page_size, warm_start=
            warm_start, params=params, **kwargs)
        return response

    def tree_hierarchy_objects(self, warm_start: bool = False,
        single_page: bool = False, page_size: int = 5000,
        kwargs: dict = None, **params) -> list:
        """Tree Hierarchy Objects

        Args:
            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.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            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
            null_fields (string optional): additional filter - parameter
            extract_data_profile (boolean optional): additional filter - parameter
            extract_severity (boolean optional): Se True nella risposta e' anche presente la severita, Default to False. - parameter
            extract_ip_cidr (boolean optional): additional filter - parameter
            uuid_customer (string optional): additional filter - parameter
            customer_code (string optional): additional filter - parameter
            customer_status (string optional): additional filter - parameter
            uuid_site (string optional): additional filter - parameter
            site_code (string optional): additional filter - parameter
            site_description (string optional): additional filter - parameter
            site_address (string optional): additional filter - parameter
            site_zip_code (string optional): additional filter - parameter
            site_city (string optional): additional filter - parameter
            site_country (string optional): additional filter - parameter
            site_state_province (string optional): additional filter - parameter
            site_status (string optional): additional filter - parameter
            uuid_group (string optional): additional filter - parameter
            group_name (string optional): additional filter - parameter
            group_status (string optional): additional filter - parameter
            group_type (string optional): additional filter - parameter
            uuid_object (string optional): additional filter - parameter
            object_name (string optional): additional filter - parameter
            object_status (string optional): additional filter - parameter
            object_profile (string optional): additional filter - parameter
            uuid_virtual_domain (string optional): additional filter - parameter
            virtual_domain_name (string optional): additional filter - parameter
            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
            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
            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
            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

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['sort_by', 'null_fields',
            'extract_data_profile', 'extract_severity', 'extract_ip_cidr',
            'uuid_customer', 'customer_code', 'customer_status',
            'uuid_site', 'site_code', 'site_description', 'site_address',
            'site_zip_code', 'site_city', 'site_country',
            'site_state_province', 'site_status', 'uuid_group',
            'group_name', 'group_status', 'group_type', 'uuid_object',
            'object_name', 'object_status', 'object_profile',
            'uuid_virtual_domain', 'virtual_domain_name', 'skip', 'limit',
            'like', 'join', 'count']
        params.get('sort_by'), params.get('null_fields'), params.get(
            'extract_data_profile'), params.get('extract_severity'
            ), params.get('extract_ip_cidr'), params.get('uuid_customer'
            ), params.get('customer_code'), params.get('customer_status'
            ), params.get('uuid_site'), params.get('site_code'), params.get(
            'site_description'), params.get('site_address'), params.get(
            'site_zip_code'), params.get('site_city'), params.get(
            'site_country'), params.get('site_state_province'), params.get(
            'site_status'), params.get('uuid_group'), params.get('group_name'
            ), params.get('group_status'), params.get('group_type'
            ), params.get('uuid_object'), params.get('object_name'
            ), params.get('object_status'), params.get('object_profile'
            ), params.get('uuid_virtual_domain'), params.get(
            'virtual_domain_name'), params.get('skip'), params.get('limit'
            ), params.get('like'), params.get('join'), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.tree_hierarchy_objects.__name__,
                params, official_params_list)
        response = self.execute('GET', path=f'/tree_hierarchy/objects',
            single_page=single_page, page_size=page_size, warm_start=
            warm_start, params=params, **kwargs)
        return response

    def tree_hierarchy_metric_types(self, warm_start: bool = False,
        single_page: bool = False, page_size: int = 5000,
        kwargs: dict = None, **params) -> list:
        """Tree Hierarchy Metric Types

        Args:
            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.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            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
            null_fields (string optional): additional filter - parameter
            uuid_customer (string optional): additional filter - parameter
            customer_code (string optional): additional filter - parameter
            customer_status (string optional): additional filter - parameter
            uuid_site (string optional): additional filter - parameter
            site_code (string optional): additional filter - parameter
            site_description (string optional): additional filter - parameter
            site_address (string optional): additional filter - parameter
            site_zip_code (string optional): additional filter - parameter
            site_city (string optional): additional filter - parameter
            site_country (string optional): additional filter - parameter
            site_state_province (string optional): additional filter - parameter
            site_status (string optional): additional filter - parameter
            uuid_group (string optional): additional filter - parameter
            group_name (string optional): additional filter - parameter
            group_status (string optional): additional filter - parameter
            group_type (string optional): additional filter - parameter
            uuid_object (string optional): additional filter - parameter
            object_name (string optional): additional filter - parameter
            object_status (string optional): additional filter - parameter
            object_profile (string optional): additional filter - parameter
            metric_type_name (string optional): additional filter - parameter
            metric_type_status (string optional): additional filter - parameter
            metric_type_profile (string optional): additional filter - parameter
            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
            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
            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
            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

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['sort_by', 'null_fields', 'uuid_customer',
            'customer_code', 'customer_status', 'uuid_site', 'site_code',
            'site_description', 'site_address', 'site_zip_code',
            'site_city', 'site_country', 'site_state_province',
            'site_status', 'uuid_group', 'group_name', 'group_status',
            'group_type', 'uuid_object', 'object_name', 'object_status',
            'object_profile', 'metric_type_name', 'metric_type_status',
            'metric_type_profile', 'skip', 'limit', 'like', 'join', 'count']
        params.get('sort_by'), params.get('null_fields'), params.get(
            'uuid_customer'), params.get('customer_code'), params.get(
            'customer_status'), params.get('uuid_site'), params.get('site_code'
            ), params.get('site_description'), params.get('site_address'
            ), params.get('site_zip_code'), params.get('site_city'
            ), params.get('site_country'), params.get('site_state_province'
            ), params.get('site_status'), params.get('uuid_group'), params.get(
            'group_name'), params.get('group_status'), params.get('group_type'
            ), params.get('uuid_object'), params.get('object_name'
            ), params.get('object_status'), params.get('object_profile'
            ), params.get('metric_type_name'), params.get('metric_type_status'
            ), params.get('metric_type_profile'), params.get('skip'
            ), params.get('limit'), params.get('like'), params.get('join'
            ), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.tree_hierarchy_metric_types.
                __name__, params, official_params_list)
        response = self.execute('GET', path=f'/tree_hierarchy/metric_types',
            single_page=single_page, page_size=page_size, warm_start=
            warm_start, params=params, **kwargs)
        return response

    def tree_hierarchy_metrics(self, warm_start: bool = False,
        single_page: bool = False, page_size: int = 5000,
        kwargs: dict = None, **params) -> list:
        """Tree Hierarchy Metrics

        Args:
            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.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            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
            null_fields (string optional): additional filter - parameter
            uuid_customer (string optional): additional filter - parameter
            customer_code (string optional): additional filter - parameter
            customer_status (string optional): additional filter - parameter
            uuid_site (string optional): additional filter - parameter
            site_code (string optional): additional filter - parameter
            site_description (string optional): additional filter - parameter
            site_address (string optional): additional filter - parameter
            site_zip_code (string optional): additional filter - parameter
            site_city (string optional): additional filter - parameter
            site_country (string optional): additional filter - parameter
            site_state_province (string optional): additional filter - parameter
            site_status (string optional): additional filter - parameter
            uuid_group (string optional): additional filter - parameter
            group_name (string optional): additional filter - parameter
            group_status (string optional): additional filter - parameter
            group_type (string optional): additional filter - parameter
            uuid_object (string optional): additional filter - parameter
            object_name (string optional): additional filter - parameter
            object_status (string optional): additional filter - parameter
            object_profile (string optional): additional filter - parameter
            metric_type_name (string optional): additional filter - parameter
            metric_type_status (string optional): additional filter - parameter
            uuid_metric (string optional): additional filter - parameter
            metric_name (string optional): additional filter - parameter
            metric_status (string optional): additional filter - parameter
            metric_profile (string optional): additional filter - parameter
            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
            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
            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
            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

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['sort_by', 'null_fields', 'uuid_customer',
            'customer_code', 'customer_status', 'uuid_site', 'site_code',
            'site_description', 'site_address', 'site_zip_code',
            'site_city', 'site_country', 'site_state_province',
            'site_status', 'uuid_group', 'group_name', 'group_status',
            'group_type', 'uuid_object', 'object_name', 'object_status',
            'object_profile', 'metric_type_name', 'metric_type_status',
            'uuid_metric', 'metric_name', 'metric_status', 'metric_profile',
            'skip', 'limit', 'like', 'join', 'count']
        params.get('sort_by'), params.get('null_fields'), params.get(
            'uuid_customer'), params.get('customer_code'), params.get(
            'customer_status'), params.get('uuid_site'), params.get('site_code'
            ), params.get('site_description'), params.get('site_address'
            ), params.get('site_zip_code'), params.get('site_city'
            ), params.get('site_country'), params.get('site_state_province'
            ), params.get('site_status'), params.get('uuid_group'), params.get(
            'group_name'), params.get('group_status'), params.get('group_type'
            ), params.get('uuid_object'), params.get('object_name'
            ), params.get('object_status'), params.get('object_profile'
            ), params.get('metric_type_name'), params.get('metric_type_status'
            ), params.get('uuid_metric'), params.get('metric_name'
            ), params.get('metric_status'), params.get('metric_profile'
            ), params.get('skip'), params.get('limit'), params.get('like'
            ), params.get('join'), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.tree_hierarchy_metrics.__name__,
                params, official_params_list)
        response = self.execute('GET', path=f'/tree_hierarchy/metrics',
            single_page=single_page, page_size=page_size, warm_start=
            warm_start, params=params, **kwargs)
        return response

    def tree_hierarchy_metrics_average(self, warm_start: bool = False,
        single_page: bool = False, page_size: int = 5000,
        kwargs: dict = None, **params) -> list:
        """Tree Hierarchy Metrics Average

        Args:
            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.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            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
            null_fields (string optional): additional filter - parameter
            ts_start (string optional): additional filter - parameter
            ts_end (string optional): additional filter - parameter
            uuid_customer (string optional): additional filter - parameter
            customer_code (string optional): additional filter - parameter
            customer_status (string optional): additional filter - parameter
            uuid_site (string optional): additional filter - parameter
            site_code (string optional): additional filter - parameter
            site_description (string optional): additional filter - parameter
            site_address (string optional): additional filter - parameter
            site_zip_code (string optional): additional filter - parameter
            site_city (string optional): additional filter - parameter
            site_country (string optional): additional filter - parameter
            site_state_province (string optional): additional filter - parameter
            site_status (string optional): additional filter - parameter
            uuid_group (string optional): additional filter - parameter
            group_name (string optional): additional filter - parameter
            group_status (string optional): additional filter - parameter
            group_type (string optional): additional filter - parameter
            uuid_object (string optional): additional filter - parameter
            object_name (string optional): additional filter - parameter
            object_status (string optional): additional filter - parameter
            object_profile (string optional): additional filter - parameter
            metric_type_name (string optional): additional filter - parameter
            metric_type_status (string optional): additional filter - parameter
            uuid_metric (string optional): additional filter - parameter
            metric_name (string optional): additional filter - parameter
            metric_status (string optional): additional filter - parameter
            metric_profile (string optional): additional filter - parameter
            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
            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
            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
            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

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['sort_by', 'null_fields', 'ts_start',
            'ts_end', 'uuid_customer', 'customer_code', 'customer_status',
            'uuid_site', 'site_code', 'site_description', 'site_address',
            'site_zip_code', 'site_city', 'site_country',
            'site_state_province', 'site_status', 'uuid_group',
            'group_name', 'group_status', 'group_type', 'uuid_object',
            'object_name', 'object_status', 'object_profile',
            'metric_type_name', 'metric_type_status', 'uuid_metric',
            'metric_name', 'metric_status', 'metric_profile', 'skip',
            'limit', 'like', 'join', 'count']
        params.get('sort_by'), params.get('null_fields'), params.get('ts_start'
            ), params.get('ts_end'), params.get('uuid_customer'), params.get(
            'customer_code'), params.get('customer_status'), params.get(
            'uuid_site'), params.get('site_code'), params.get(
            'site_description'), params.get('site_address'), params.get(
            'site_zip_code'), params.get('site_city'), params.get(
            'site_country'), params.get('site_state_province'), params.get(
            'site_status'), params.get('uuid_group'), params.get('group_name'
            ), params.get('group_status'), params.get('group_type'
            ), params.get('uuid_object'), params.get('object_name'
            ), params.get('object_status'), params.get('object_profile'
            ), params.get('metric_type_name'), params.get('metric_type_status'
            ), params.get('uuid_metric'), params.get('metric_name'
            ), params.get('metric_status'), params.get('metric_profile'
            ), params.get('skip'), params.get('limit'), params.get('like'
            ), params.get('join'), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.tree_hierarchy_metrics_average.
                __name__, params, official_params_list)
        response = self.execute('GET', path=
            f'/tree_hierarchy/metrics/average/', single_page=single_page,
            page_size=page_size, warm_start=warm_start, params=params, **kwargs
            )
        return response

tree_hierarchy_groups(warm_start=False, single_page=False, page_size=5000, kwargs=None, **params)

Tree Hierarchy Groups

Parameters:

Name Type Description Default
warm_start bool

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.

 False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

 False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 5000.

 5000
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
extract_severity boolean optional

Se True nella risposta e' anche presente la severita, Default to False. - parameter
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
null_fields string optional

additional filter - parameter
uuid_customer string optional

additional filter - parameter
customer_code string optional

additional filter - parameter
customer_status string optional

additional filter - parameter
uuid_site string optional

additional filter - parameter
site_code string optional

additional filter - parameter
site_description string optional

additional filter - parameter
site_address string optional

additional filter - parameter
site_zip_code string optional

additional filter - parameter
site_city string optional

additional filter - parameter
site_country string optional

additional filter - parameter
site_state_province string optional

additional filter - parameter
site_status string optional

additional filter - parameter
site_type string optional

additional filter - parameter
uuid_group string optional

additional filter - parameter
group_name string optional

additional filter - parameter
group_status string optional

additional filter - parameter
group_type string optional

additional filter - parameter
uuid_virtual_domain string optional

additional filter - parameter
virtual_domain_name string optional

additional filter - parameter
skip integer optional

numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
limit integer optional

numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
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
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
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

Returns: list

Source code in hive/cookbook/tree_hierarchy.py 
 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
def tree_hierarchy_groups(self, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """Tree Hierarchy Groups

    Args:
        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.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        extract_severity (boolean optional): Se True nella risposta e' anche presente la severita, Default to False. - parameter
        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
        null_fields (string optional): additional filter - parameter
        uuid_customer (string optional): additional filter - parameter
        customer_code (string optional): additional filter - parameter
        customer_status (string optional): additional filter - parameter
        uuid_site (string optional): additional filter - parameter
        site_code (string optional): additional filter - parameter
        site_description (string optional): additional filter - parameter
        site_address (string optional): additional filter - parameter
        site_zip_code (string optional): additional filter - parameter
        site_city (string optional): additional filter - parameter
        site_country (string optional): additional filter - parameter
        site_state_province (string optional): additional filter - parameter
        site_status (string optional): additional filter - parameter
        site_type (string optional): additional filter - parameter
        uuid_group (string optional): additional filter - parameter
        group_name (string optional): additional filter - parameter
        group_status (string optional): additional filter - parameter
        group_type (string optional): additional filter - parameter
        uuid_virtual_domain (string optional): additional filter - parameter
        virtual_domain_name (string optional): additional filter - parameter
        skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
        limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
        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
        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
        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

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['extract_severity', 'sort_by',
        'null_fields', 'uuid_customer', 'customer_code',
        'customer_status', 'uuid_site', 'site_code', 'site_description',
        'site_address', 'site_zip_code', 'site_city', 'site_country',
        'site_state_province', 'site_status', 'site_type', 'uuid_group',
        'group_name', 'group_status', 'group_type',
        'uuid_virtual_domain', 'virtual_domain_name', 'skip', 'limit',
        'like', 'join', 'count']
    params.get('extract_severity'), params.get('sort_by'), params.get(
        'null_fields'), params.get('uuid_customer'), params.get(
        'customer_code'), params.get('customer_status'), params.get(
        'uuid_site'), params.get('site_code'), params.get(
        'site_description'), params.get('site_address'), params.get(
        'site_zip_code'), params.get('site_city'), params.get(
        'site_country'), params.get('site_state_province'), params.get(
        'site_status'), params.get('site_type'), params.get('uuid_group'
        ), params.get('group_name'), params.get('group_status'
        ), params.get('group_type'), params.get('uuid_virtual_domain'
        ), params.get('virtual_domain_name'), params.get('skip'
        ), params.get('limit'), params.get('like'), params.get('join'
        ), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.tree_hierarchy_groups.__name__,
            params, official_params_list)
    response = self.execute('GET', path=f'/tree_hierarchy/groups',
        single_page=single_page, page_size=page_size, warm_start=
        warm_start, params=params, **kwargs)
    return response

tree_hierarchy_metric_types(warm_start=False, single_page=False, page_size=5000, kwargs=None, **params)

Tree Hierarchy Metric Types

Parameters:

Name Type Description Default
warm_start bool

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.

 False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

 False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 5000.

 5000
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
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
null_fields string optional

additional filter - parameter
uuid_customer string optional

additional filter - parameter
customer_code string optional

additional filter - parameter
customer_status string optional

additional filter - parameter
uuid_site string optional

additional filter - parameter
site_code string optional

additional filter - parameter
site_description string optional

additional filter - parameter
site_address string optional

additional filter - parameter
site_zip_code string optional

additional filter - parameter
site_city string optional

additional filter - parameter
site_country string optional

additional filter - parameter
site_state_province string optional

additional filter - parameter
site_status string optional

additional filter - parameter
uuid_group string optional

additional filter - parameter
group_name string optional

additional filter - parameter
group_status string optional

additional filter - parameter
group_type string optional

additional filter - parameter
uuid_object string optional

additional filter - parameter
object_name string optional

additional filter - parameter
object_status string optional

additional filter - parameter
object_profile string optional

additional filter - parameter
metric_type_name string optional

additional filter - parameter
metric_type_status string optional

additional filter - parameter
metric_type_profile string optional

additional filter - parameter
skip integer optional

numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
limit integer optional

numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
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
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
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

Returns: list

Source code in hive/cookbook/tree_hierarchy.py 
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
def tree_hierarchy_metric_types(self, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """Tree Hierarchy Metric Types

    Args:
        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.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        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
        null_fields (string optional): additional filter - parameter
        uuid_customer (string optional): additional filter - parameter
        customer_code (string optional): additional filter - parameter
        customer_status (string optional): additional filter - parameter
        uuid_site (string optional): additional filter - parameter
        site_code (string optional): additional filter - parameter
        site_description (string optional): additional filter - parameter
        site_address (string optional): additional filter - parameter
        site_zip_code (string optional): additional filter - parameter
        site_city (string optional): additional filter - parameter
        site_country (string optional): additional filter - parameter
        site_state_province (string optional): additional filter - parameter
        site_status (string optional): additional filter - parameter
        uuid_group (string optional): additional filter - parameter
        group_name (string optional): additional filter - parameter
        group_status (string optional): additional filter - parameter
        group_type (string optional): additional filter - parameter
        uuid_object (string optional): additional filter - parameter
        object_name (string optional): additional filter - parameter
        object_status (string optional): additional filter - parameter
        object_profile (string optional): additional filter - parameter
        metric_type_name (string optional): additional filter - parameter
        metric_type_status (string optional): additional filter - parameter
        metric_type_profile (string optional): additional filter - parameter
        skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
        limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
        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
        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
        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

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['sort_by', 'null_fields', 'uuid_customer',
        'customer_code', 'customer_status', 'uuid_site', 'site_code',
        'site_description', 'site_address', 'site_zip_code',
        'site_city', 'site_country', 'site_state_province',
        'site_status', 'uuid_group', 'group_name', 'group_status',
        'group_type', 'uuid_object', 'object_name', 'object_status',
        'object_profile', 'metric_type_name', 'metric_type_status',
        'metric_type_profile', 'skip', 'limit', 'like', 'join', 'count']
    params.get('sort_by'), params.get('null_fields'), params.get(
        'uuid_customer'), params.get('customer_code'), params.get(
        'customer_status'), params.get('uuid_site'), params.get('site_code'
        ), params.get('site_description'), params.get('site_address'
        ), params.get('site_zip_code'), params.get('site_city'
        ), params.get('site_country'), params.get('site_state_province'
        ), params.get('site_status'), params.get('uuid_group'), params.get(
        'group_name'), params.get('group_status'), params.get('group_type'
        ), params.get('uuid_object'), params.get('object_name'
        ), params.get('object_status'), params.get('object_profile'
        ), params.get('metric_type_name'), params.get('metric_type_status'
        ), params.get('metric_type_profile'), params.get('skip'
        ), params.get('limit'), params.get('like'), params.get('join'
        ), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.tree_hierarchy_metric_types.
            __name__, params, official_params_list)
    response = self.execute('GET', path=f'/tree_hierarchy/metric_types',
        single_page=single_page, page_size=page_size, warm_start=
        warm_start, params=params, **kwargs)
    return response

tree_hierarchy_metrics(warm_start=False, single_page=False, page_size=5000, kwargs=None, **params)

Tree Hierarchy Metrics

Parameters:

Name Type Description Default
warm_start bool

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.

 False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

 False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 5000.

 5000
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
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
null_fields string optional

additional filter - parameter
uuid_customer string optional

additional filter - parameter
customer_code string optional

additional filter - parameter
customer_status string optional

additional filter - parameter
uuid_site string optional

additional filter - parameter
site_code string optional

additional filter - parameter
site_description string optional

additional filter - parameter
site_address string optional

additional filter - parameter
site_zip_code string optional

additional filter - parameter
site_city string optional

additional filter - parameter
site_country string optional

additional filter - parameter
site_state_province string optional

additional filter - parameter
site_status string optional

additional filter - parameter
uuid_group string optional

additional filter - parameter
group_name string optional

additional filter - parameter
group_status string optional

additional filter - parameter
group_type string optional

additional filter - parameter
uuid_object string optional

additional filter - parameter
object_name string optional

additional filter - parameter
object_status string optional

additional filter - parameter
object_profile string optional

additional filter - parameter
metric_type_name string optional

additional filter - parameter
metric_type_status string optional

additional filter - parameter
uuid_metric string optional

additional filter - parameter
metric_name string optional

additional filter - parameter
metric_status string optional

additional filter - parameter
metric_profile string optional

additional filter - parameter
skip integer optional

numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
limit integer optional

numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
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
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
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

Returns: list

Source code in hive/cookbook/tree_hierarchy.py 
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
def tree_hierarchy_metrics(self, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """Tree Hierarchy Metrics

    Args:
        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.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        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
        null_fields (string optional): additional filter - parameter
        uuid_customer (string optional): additional filter - parameter
        customer_code (string optional): additional filter - parameter
        customer_status (string optional): additional filter - parameter
        uuid_site (string optional): additional filter - parameter
        site_code (string optional): additional filter - parameter
        site_description (string optional): additional filter - parameter
        site_address (string optional): additional filter - parameter
        site_zip_code (string optional): additional filter - parameter
        site_city (string optional): additional filter - parameter
        site_country (string optional): additional filter - parameter
        site_state_province (string optional): additional filter - parameter
        site_status (string optional): additional filter - parameter
        uuid_group (string optional): additional filter - parameter
        group_name (string optional): additional filter - parameter
        group_status (string optional): additional filter - parameter
        group_type (string optional): additional filter - parameter
        uuid_object (string optional): additional filter - parameter
        object_name (string optional): additional filter - parameter
        object_status (string optional): additional filter - parameter
        object_profile (string optional): additional filter - parameter
        metric_type_name (string optional): additional filter - parameter
        metric_type_status (string optional): additional filter - parameter
        uuid_metric (string optional): additional filter - parameter
        metric_name (string optional): additional filter - parameter
        metric_status (string optional): additional filter - parameter
        metric_profile (string optional): additional filter - parameter
        skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
        limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
        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
        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
        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

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['sort_by', 'null_fields', 'uuid_customer',
        'customer_code', 'customer_status', 'uuid_site', 'site_code',
        'site_description', 'site_address', 'site_zip_code',
        'site_city', 'site_country', 'site_state_province',
        'site_status', 'uuid_group', 'group_name', 'group_status',
        'group_type', 'uuid_object', 'object_name', 'object_status',
        'object_profile', 'metric_type_name', 'metric_type_status',
        'uuid_metric', 'metric_name', 'metric_status', 'metric_profile',
        'skip', 'limit', 'like', 'join', 'count']
    params.get('sort_by'), params.get('null_fields'), params.get(
        'uuid_customer'), params.get('customer_code'), params.get(
        'customer_status'), params.get('uuid_site'), params.get('site_code'
        ), params.get('site_description'), params.get('site_address'
        ), params.get('site_zip_code'), params.get('site_city'
        ), params.get('site_country'), params.get('site_state_province'
        ), params.get('site_status'), params.get('uuid_group'), params.get(
        'group_name'), params.get('group_status'), params.get('group_type'
        ), params.get('uuid_object'), params.get('object_name'
        ), params.get('object_status'), params.get('object_profile'
        ), params.get('metric_type_name'), params.get('metric_type_status'
        ), params.get('uuid_metric'), params.get('metric_name'
        ), params.get('metric_status'), params.get('metric_profile'
        ), params.get('skip'), params.get('limit'), params.get('like'
        ), params.get('join'), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.tree_hierarchy_metrics.__name__,
            params, official_params_list)
    response = self.execute('GET', path=f'/tree_hierarchy/metrics',
        single_page=single_page, page_size=page_size, warm_start=
        warm_start, params=params, **kwargs)
    return response

tree_hierarchy_metrics_average(warm_start=False, single_page=False, page_size=5000, kwargs=None, **params)

Tree Hierarchy Metrics Average

Parameters:

Name Type Description Default
warm_start bool

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.

 False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

 False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 5000.

 5000
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
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
null_fields string optional

additional filter - parameter
ts_start string optional

additional filter - parameter
ts_end string optional

additional filter - parameter
uuid_customer string optional

additional filter - parameter
customer_code string optional

additional filter - parameter
customer_status string optional

additional filter - parameter
uuid_site string optional

additional filter - parameter
site_code string optional

additional filter - parameter
site_description string optional

additional filter - parameter
site_address string optional

additional filter - parameter
site_zip_code string optional

additional filter - parameter
site_city string optional

additional filter - parameter
site_country string optional

additional filter - parameter
site_state_province string optional

additional filter - parameter
site_status string optional

additional filter - parameter
uuid_group string optional

additional filter - parameter
group_name string optional

additional filter - parameter
group_status string optional

additional filter - parameter
group_type string optional

additional filter - parameter
uuid_object string optional

additional filter - parameter
object_name string optional

additional filter - parameter
object_status string optional

additional filter - parameter
object_profile string optional

additional filter - parameter
metric_type_name string optional

additional filter - parameter
metric_type_status string optional

additional filter - parameter
uuid_metric string optional

additional filter - parameter
metric_name string optional

additional filter - parameter
metric_status string optional

additional filter - parameter
metric_profile string optional

additional filter - parameter
skip integer optional

numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
limit integer optional

numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
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
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
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

Returns: list

Source code in hive/cookbook/tree_hierarchy.py 
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
def tree_hierarchy_metrics_average(self, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """Tree Hierarchy Metrics Average

    Args:
        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.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        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
        null_fields (string optional): additional filter - parameter
        ts_start (string optional): additional filter - parameter
        ts_end (string optional): additional filter - parameter
        uuid_customer (string optional): additional filter - parameter
        customer_code (string optional): additional filter - parameter
        customer_status (string optional): additional filter - parameter
        uuid_site (string optional): additional filter - parameter
        site_code (string optional): additional filter - parameter
        site_description (string optional): additional filter - parameter
        site_address (string optional): additional filter - parameter
        site_zip_code (string optional): additional filter - parameter
        site_city (string optional): additional filter - parameter
        site_country (string optional): additional filter - parameter
        site_state_province (string optional): additional filter - parameter
        site_status (string optional): additional filter - parameter
        uuid_group (string optional): additional filter - parameter
        group_name (string optional): additional filter - parameter
        group_status (string optional): additional filter - parameter
        group_type (string optional): additional filter - parameter
        uuid_object (string optional): additional filter - parameter
        object_name (string optional): additional filter - parameter
        object_status (string optional): additional filter - parameter
        object_profile (string optional): additional filter - parameter
        metric_type_name (string optional): additional filter - parameter
        metric_type_status (string optional): additional filter - parameter
        uuid_metric (string optional): additional filter - parameter
        metric_name (string optional): additional filter - parameter
        metric_status (string optional): additional filter - parameter
        metric_profile (string optional): additional filter - parameter
        skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
        limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
        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
        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
        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

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['sort_by', 'null_fields', 'ts_start',
        'ts_end', 'uuid_customer', 'customer_code', 'customer_status',
        'uuid_site', 'site_code', 'site_description', 'site_address',
        'site_zip_code', 'site_city', 'site_country',
        'site_state_province', 'site_status', 'uuid_group',
        'group_name', 'group_status', 'group_type', 'uuid_object',
        'object_name', 'object_status', 'object_profile',
        'metric_type_name', 'metric_type_status', 'uuid_metric',
        'metric_name', 'metric_status', 'metric_profile', 'skip',
        'limit', 'like', 'join', 'count']
    params.get('sort_by'), params.get('null_fields'), params.get('ts_start'
        ), params.get('ts_end'), params.get('uuid_customer'), params.get(
        'customer_code'), params.get('customer_status'), params.get(
        'uuid_site'), params.get('site_code'), params.get(
        'site_description'), params.get('site_address'), params.get(
        'site_zip_code'), params.get('site_city'), params.get(
        'site_country'), params.get('site_state_province'), params.get(
        'site_status'), params.get('uuid_group'), params.get('group_name'
        ), params.get('group_status'), params.get('group_type'
        ), params.get('uuid_object'), params.get('object_name'
        ), params.get('object_status'), params.get('object_profile'
        ), params.get('metric_type_name'), params.get('metric_type_status'
        ), params.get('uuid_metric'), params.get('metric_name'
        ), params.get('metric_status'), params.get('metric_profile'
        ), params.get('skip'), params.get('limit'), params.get('like'
        ), params.get('join'), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.tree_hierarchy_metrics_average.
            __name__, params, official_params_list)
    response = self.execute('GET', path=
        f'/tree_hierarchy/metrics/average/', single_page=single_page,
        page_size=page_size, warm_start=warm_start, params=params, **kwargs
        )
    return response

tree_hierarchy_objects(warm_start=False, single_page=False, page_size=5000, kwargs=None, **params)

Tree Hierarchy Objects

Parameters:

Name Type Description Default
warm_start bool

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.

 False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

 False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 5000.

 5000
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
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
null_fields string optional

additional filter - parameter
extract_data_profile boolean optional

additional filter - parameter
extract_severity boolean optional

Se True nella risposta e' anche presente la severita, Default to False. - parameter
extract_ip_cidr boolean optional

additional filter - parameter
uuid_customer string optional

additional filter - parameter
customer_code string optional

additional filter - parameter
customer_status string optional

additional filter - parameter
uuid_site string optional

additional filter - parameter
site_code string optional

additional filter - parameter
site_description string optional

additional filter - parameter
site_address string optional

additional filter - parameter
site_zip_code string optional

additional filter - parameter
site_city string optional

additional filter - parameter
site_country string optional

additional filter - parameter
site_state_province string optional

additional filter - parameter
site_status string optional

additional filter - parameter
uuid_group string optional

additional filter - parameter
group_name string optional

additional filter - parameter
group_status string optional

additional filter - parameter
group_type string optional

additional filter - parameter
uuid_object string optional

additional filter - parameter
object_name string optional

additional filter - parameter
object_status string optional

additional filter - parameter
object_profile string optional

additional filter - parameter
uuid_virtual_domain string optional

additional filter - parameter
virtual_domain_name string optional

additional filter - parameter
skip integer optional

numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
limit integer optional

numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
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
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
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

Returns: list

Source code in hive/cookbook/tree_hierarchy.py 
 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
159
160
def tree_hierarchy_objects(self, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """Tree Hierarchy Objects

    Args:
        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.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        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
        null_fields (string optional): additional filter - parameter
        extract_data_profile (boolean optional): additional filter - parameter
        extract_severity (boolean optional): Se True nella risposta e' anche presente la severita, Default to False. - parameter
        extract_ip_cidr (boolean optional): additional filter - parameter
        uuid_customer (string optional): additional filter - parameter
        customer_code (string optional): additional filter - parameter
        customer_status (string optional): additional filter - parameter
        uuid_site (string optional): additional filter - parameter
        site_code (string optional): additional filter - parameter
        site_description (string optional): additional filter - parameter
        site_address (string optional): additional filter - parameter
        site_zip_code (string optional): additional filter - parameter
        site_city (string optional): additional filter - parameter
        site_country (string optional): additional filter - parameter
        site_state_province (string optional): additional filter - parameter
        site_status (string optional): additional filter - parameter
        uuid_group (string optional): additional filter - parameter
        group_name (string optional): additional filter - parameter
        group_status (string optional): additional filter - parameter
        group_type (string optional): additional filter - parameter
        uuid_object (string optional): additional filter - parameter
        object_name (string optional): additional filter - parameter
        object_status (string optional): additional filter - parameter
        object_profile (string optional): additional filter - parameter
        uuid_virtual_domain (string optional): additional filter - parameter
        virtual_domain_name (string optional): additional filter - parameter
        skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
        limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
        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
        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
        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

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['sort_by', 'null_fields',
        'extract_data_profile', 'extract_severity', 'extract_ip_cidr',
        'uuid_customer', 'customer_code', 'customer_status',
        'uuid_site', 'site_code', 'site_description', 'site_address',
        'site_zip_code', 'site_city', 'site_country',
        'site_state_province', 'site_status', 'uuid_group',
        'group_name', 'group_status', 'group_type', 'uuid_object',
        'object_name', 'object_status', 'object_profile',
        'uuid_virtual_domain', 'virtual_domain_name', 'skip', 'limit',
        'like', 'join', 'count']
    params.get('sort_by'), params.get('null_fields'), params.get(
        'extract_data_profile'), params.get('extract_severity'
        ), params.get('extract_ip_cidr'), params.get('uuid_customer'
        ), params.get('customer_code'), params.get('customer_status'
        ), params.get('uuid_site'), params.get('site_code'), params.get(
        'site_description'), params.get('site_address'), params.get(
        'site_zip_code'), params.get('site_city'), params.get(
        'site_country'), params.get('site_state_province'), params.get(
        'site_status'), params.get('uuid_group'), params.get('group_name'
        ), params.get('group_status'), params.get('group_type'
        ), params.get('uuid_object'), params.get('object_name'
        ), params.get('object_status'), params.get('object_profile'
        ), params.get('uuid_virtual_domain'), params.get(
        'virtual_domain_name'), params.get('skip'), params.get('limit'
        ), params.get('like'), params.get('join'), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.tree_hierarchy_objects.__name__,
            params, official_params_list)
    response = self.execute('GET', path=f'/tree_hierarchy/objects',
        single_page=single_page, page_size=page_size, warm_start=
        warm_start, params=params, **kwargs)
    return response