Skip to content

Hive.cookbook.metric ingest

MetricIngest

Bases: ApiManager

Class that handles all the XAutomata metric_ingest APIs

Source code in hive/cookbook/metric_ingest.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
class MetricIngest(ApiManager):
    """Class that handles all the XAutomata metric_ingest APIs"""

    def metric_ingest_create(self, payload: list, single_page: bool = False,
        page_size: int = 50, kwargs: dict = None) -> list:
        """Insert Metric

        Args:
            payload (list[dict], optional): List dict to create.
            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 50.
            kwargs (dict, optional): additional parameters for execute. Default to None.

        Examples:
            payload = 
          [
           {
            "uuid_metric_0": "string", required
            "uuid_probe_0": "string", required
            "timestamp_0": "integer", required
            "object_type_0": "None", optional
            "extended_attributes_0": "string", optional
            "value_0": "string", required
            "unit_0": "string", required
            "description_0": "string", required
            "status_0": "None", required
            "ranking_0": "integer", required
            "uuid_metric_1": "string", required
            "uuid_probe_1": "string", required
            "timestamp_1": "integer", required
            "object_type_1": "None", optional
            "extended_attributes_1": "string", optional
            "status_1": "None", required
            "ranking_1": "integer", required
            "description_1": "string", required
            "uuid_metric_2": "string", required
            "uuid_probe_2": "string", required
            "timestamp_2": "integer", required
            "object_type_2": "None", optional
            "extended_attributes_2": "string", required
            "description_2": "string", optional
            "uuid_metric_3": "string", required
            "uuid_probe_3": "string", required
            "timestamp_3": "integer", required
            "object_type_3": "None", optional
            "unit_3": "string", required
            "value_3": "number", required
           }
          ]

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        response = self.execute('POST', path=f'/metric_ingest/',
            single_page=single_page, page_size=page_size, payload=payload,
            **kwargs)
        return response

metric_ingest_create(payload, single_page=False, page_size=50, kwargs=None)

Insert Metric

Parameters:

Name Type Description Default
payload list[dict]

List dict to create.

 required
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 50.

 50
kwargs dict

additional parameters for execute. Default to None.

 None

Examples:

payload =

[ { "uuid_metric_0": "string", required "uuid_probe_0": "string", required "timestamp_0": "integer", required "object_type_0": "None", optional "extended_attributes_0": "string", optional "value_0": "string", required "unit_0": "string", required "description_0": "string", required "status_0": "None", required "ranking_0": "integer", required "uuid_metric_1": "string", required "uuid_probe_1": "string", required "timestamp_1": "integer", required "object_type_1": "None", optional "extended_attributes_1": "string", optional "status_1": "None", required "ranking_1": "integer", required "description_1": "string", required "uuid_metric_2": "string", required "uuid_probe_2": "string", required "timestamp_2": "integer", required "object_type_2": "None", optional "extended_attributes_2": "string", required "description_2": "string", optional "uuid_metric_3": "string", required "uuid_probe_3": "string", required "timestamp_3": "integer", required "object_type_3": "None", optional "unit_3": "string", required "value_3": "number", required } ]

Returns: list

Source code in hive/cookbook/metric_ingest.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
def metric_ingest_create(self, payload: list, single_page: bool = False,
    page_size: int = 50, kwargs: dict = None) -> list:
    """Insert Metric

    Args:
        payload (list[dict], optional): List dict to create.
        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 50.
        kwargs (dict, optional): additional parameters for execute. Default to None.

    Examples:
        payload = 
      [
       {
        "uuid_metric_0": "string", required
        "uuid_probe_0": "string", required
        "timestamp_0": "integer", required
        "object_type_0": "None", optional
        "extended_attributes_0": "string", optional
        "value_0": "string", required
        "unit_0": "string", required
        "description_0": "string", required
        "status_0": "None", required
        "ranking_0": "integer", required
        "uuid_metric_1": "string", required
        "uuid_probe_1": "string", required
        "timestamp_1": "integer", required
        "object_type_1": "None", optional
        "extended_attributes_1": "string", optional
        "status_1": "None", required
        "ranking_1": "integer", required
        "description_1": "string", required
        "uuid_metric_2": "string", required
        "uuid_probe_2": "string", required
        "timestamp_2": "integer", required
        "object_type_2": "None", optional
        "extended_attributes_2": "string", required
        "description_2": "string", optional
        "uuid_metric_3": "string", required
        "uuid_probe_3": "string", required
        "timestamp_3": "integer", required
        "object_type_3": "None", optional
        "unit_3": "string", required
        "value_3": "number", required
       }
      ]

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    response = self.execute('POST', path=f'/metric_ingest/',
        single_page=single_page, page_size=page_size, payload=payload,
        **kwargs)
    return response