Skip to content

Hive.cookbook.ts service status

TsServiceStatus

Bases: ApiManager

Class that handles all the XAutomata ts_service_status APIs

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

    def ts_service_status(self, warm_start: bool = False,
        single_page: bool = False, page_size: int = 5000,
        kwargs: dict = None, **params) -> list:
        """Read Status Services

        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
            uuid_service (string optional): additional filter - parameter
            timestamp_start (string optional): additional filter - parameter
            timestamp_end (string optional): additional filter - parameter
            database_timestamp_start (string optional): additional filter - parameter
            database_timestamp_end (string optional): additional filter - parameter
            status (None optional): additional filter - parameter
            ranking (integer optional): additional filter - parameter
            description (string optional): additional filter - parameter
            null_fields (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', 'uuid_service',
            'timestamp_start', 'timestamp_end', 'database_timestamp_start',
            'database_timestamp_end', 'status', 'ranking', 'description',
            'null_fields', 'skip', 'limit', 'like', 'join', 'count']
        params.get('sort_by'), params.get('uuid_service'), params.get(
            'timestamp_start'), params.get('timestamp_end'), params.get(
            'database_timestamp_start'), params.get('database_timestamp_end'
            ), params.get('status'), params.get('ranking'), params.get(
            'description'), params.get('null_fields'), params.get('skip'
            ), params.get('limit'), params.get('like'), params.get('join'
            ), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.ts_service_status.__name__,
                params, official_params_list)
        response = self.execute('GET', path=f'/ts_service_status/',
            single_page=single_page, page_size=page_size, warm_start=
            warm_start, params=params, **kwargs)
        return response

    def ts_service_status_create(self, kwargs: dict = None, **payload) -> list:
        """Create Timeseries Service Status

        Args:
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **payload: additional parameters for the API.

        Keyword Args:
            uuid_service (string required): additional filter - payload
            timestamp (string required): additional filter - payload
            status (None optional): additional filter - payload
            ranking (integer optional): additional filter - payload
            description (string optional): additional filter - payload
            extended_attributes (array object optional): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['uuid_service', 'timestamp', 'status',
            'ranking', 'description', 'extended_attributes']
        payload.get('uuid_service'), payload.get('timestamp'), payload.get(
            'status'), payload.get('ranking'), payload.get('description'
            ), payload.get('extended_attributes')
        if not self._silence_warning:
            warning_wrong_parameters(self.ts_service_status_create.__name__,
                payload, official_payload_list)
        response = self.execute('POST', path=f'/ts_service_status/',
            payload=payload, **kwargs)
        return response

    def ts_service_status_delete(self, uuid_service: str,
        kwargs: dict = None, **params) -> list:
        """Delete Timeseries Service Status

        Args:
            uuid_service (str, required): uuid_service
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            ts_start (string required): additional filter - parameter
            ts_end (string required): additional filter - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['ts_start', 'ts_end']
        params.get('ts_start'), params.get('ts_end')
        if not self._silence_warning:
            warning_wrong_parameters(self.ts_service_status_delete.__name__,
                params, official_params_list)
        response = self.execute('DELETE', path=
            f'/ts_service_status/{uuid_service}/', params=params, **kwargs)
        return response

    def ts_service_status_query(self, warm_start: bool = False,
        single_page: bool = False, page_size: int = 5000,
        kwargs: dict = None, **params) -> list:
        """Read Services

        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_parent (string optional): additional filter - parameter
            uuid_customer (string optional): additional filter - parameter
            profile (string optional): additional filter - parameter
            name (string optional): additional filter - parameter
            description (string optional): additional filter - parameter
            status (string optional): additional filter - parameter
            ts_description (string optional): additional filter - parameter
            ts_status (None optional): additional filter - parameter
            ts_timestamp_start (string optional): additional filter - parameter
            ts_timestamp_end (string optional): additional filter - parameter
            ts_ranking (integer 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_parent',
            'uuid_customer', 'profile', 'name', 'description', 'status',
            'ts_description', 'ts_status', 'ts_timestamp_start',
            'ts_timestamp_end', 'ts_ranking', 'skip', 'limit', 'like',
            'join', 'count']
        params.get('sort_by'), params.get('null_fields'), params.get(
            'uuid_parent'), params.get('uuid_customer'), params.get('profile'
            ), params.get('name'), params.get('description'), params.get(
            'status'), params.get('ts_description'), params.get('ts_status'
            ), params.get('ts_timestamp_start'), params.get('ts_timestamp_end'
            ), params.get('ts_ranking'), params.get('skip'), params.get('limit'
            ), params.get('like'), params.get('join'), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.ts_service_status_query.__name__,
                params, official_params_list)
        response = self.execute('GET', path=f'/ts_service_status/query/',
            single_page=single_page, page_size=page_size, warm_start=
            warm_start, params=params, **kwargs)
        return response

    def ts_service_status_bulk(self, payload: list,
        warm_start: bool = False, single_page: bool = False,
        page_size: int = 50, kwargs: dict = None, **params) -> list:
        """Read Status Metrics

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

        Keyword Args:
            ts_start (string required): additional filter - parameter
            ts_end (string required): additional filter - parameter

        Examples:
            payload = 
          [
            "uuid": "str", required
          ]

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['ts_start', 'ts_end']
        params.get('ts_start'), params.get('ts_end')
        if not self._silence_warning:
            warning_wrong_parameters(self.ts_service_status_bulk.__name__,
                params, official_params_list)
        response = self.execute('POST', path=
            f'/ts_service_status/bulk/read/', single_page=single_page,
            page_size=page_size, warm_start=warm_start, params=params,
            payload=payload, **kwargs)
        return response

    def ts_service_status_create_bulk(self, payload: list,
        single_page: bool = False, page_size: int = 50, kwargs: dict = None
        ) -> list:
        """Bulk Create Ts Service Status

        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_service": "string", required
            "timestamp": "string", required
            "status": "None", optional
            "ranking": "integer", optional
            "description": "string", optional
            "extended_attributes": "array object", optional
           }
          ]

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

    def ts_service_status_delete_bulk(self, payload: list,
        single_page: bool = False, page_size: int = 50, kwargs: dict = None,
        **params) -> list:
        """Bulk Delete Ts Service Status

        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.
            **params: additional parameters for the API.

        Keyword Args:
            ts_start (string required): additional filter - parameter
            ts_end (string required): additional filter - parameter

        Examples:
            payload = 
          [
            "uuid": "str", required
          ]

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['ts_start', 'ts_end']
        params.get('ts_start'), params.get('ts_end')
        if not self._silence_warning:
            warning_wrong_parameters(self.ts_service_status_delete_bulk.
                __name__, params, official_params_list)
        response = self.execute('POST', path=
            f'/ts_service_status/bulk/delete/', single_page=single_page,
            page_size=page_size, params=params, payload=payload, **kwargs)
        return response

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

Read Status Services

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
uuid_service string optional

additional filter - parameter
timestamp_start string optional

additional filter - parameter
timestamp_end string optional

additional filter - parameter
database_timestamp_start string optional

additional filter - parameter
database_timestamp_end string optional

additional filter - parameter
status None optional

additional filter - parameter
ranking integer optional

additional filter - parameter
description string optional

additional filter - parameter
null_fields 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/ts_service_status.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
def ts_service_status(self, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """Read Status Services

    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
        uuid_service (string optional): additional filter - parameter
        timestamp_start (string optional): additional filter - parameter
        timestamp_end (string optional): additional filter - parameter
        database_timestamp_start (string optional): additional filter - parameter
        database_timestamp_end (string optional): additional filter - parameter
        status (None optional): additional filter - parameter
        ranking (integer optional): additional filter - parameter
        description (string optional): additional filter - parameter
        null_fields (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', 'uuid_service',
        'timestamp_start', 'timestamp_end', 'database_timestamp_start',
        'database_timestamp_end', 'status', 'ranking', 'description',
        'null_fields', 'skip', 'limit', 'like', 'join', 'count']
    params.get('sort_by'), params.get('uuid_service'), params.get(
        'timestamp_start'), params.get('timestamp_end'), params.get(
        'database_timestamp_start'), params.get('database_timestamp_end'
        ), params.get('status'), params.get('ranking'), params.get(
        'description'), params.get('null_fields'), params.get('skip'
        ), params.get('limit'), params.get('like'), params.get('join'
        ), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.ts_service_status.__name__,
            params, official_params_list)
    response = self.execute('GET', path=f'/ts_service_status/',
        single_page=single_page, page_size=page_size, warm_start=
        warm_start, params=params, **kwargs)
    return response

ts_service_status_bulk(payload, warm_start=False, single_page=False, page_size=50, kwargs=None, **params)

Read Status Metrics

Parameters:

Name Type Description Default
payload list[dict]

List dict to create.

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

 50
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
ts_start string required

additional filter - parameter
ts_end string required

additional filter - parameter

Examples:

payload =

[ "uuid": "str", required ]

Returns: list

Source code in hive/cookbook/ts_service_status.py 
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
def ts_service_status_bulk(self, payload: list,
    warm_start: bool = False, single_page: bool = False,
    page_size: int = 50, kwargs: dict = None, **params) -> list:
    """Read Status Metrics

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

    Keyword Args:
        ts_start (string required): additional filter - parameter
        ts_end (string required): additional filter - parameter

    Examples:
        payload = 
      [
        "uuid": "str", required
      ]

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['ts_start', 'ts_end']
    params.get('ts_start'), params.get('ts_end')
    if not self._silence_warning:
        warning_wrong_parameters(self.ts_service_status_bulk.__name__,
            params, official_params_list)
    response = self.execute('POST', path=
        f'/ts_service_status/bulk/read/', single_page=single_page,
        page_size=page_size, warm_start=warm_start, params=params,
        payload=payload, **kwargs)
    return response

ts_service_status_create(kwargs=None, **payload)

Create Timeseries Service Status

Parameters:

Name Type Description Default
kwargs dict

additional parameters for execute. Default to None.

 None
**payload

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
uuid_service string required

additional filter - payload
timestamp string required

additional filter - payload
status None optional

additional filter - payload
ranking integer optional

additional filter - payload
description string optional

additional filter - payload
extended_attributes array object optional

additional filter - payload

Returns: list

Source code in hive/cookbook/ts_service_status.py 
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
def ts_service_status_create(self, kwargs: dict = None, **payload) -> list:
    """Create Timeseries Service Status

    Args:
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **payload: additional parameters for the API.

    Keyword Args:
        uuid_service (string required): additional filter - payload
        timestamp (string required): additional filter - payload
        status (None optional): additional filter - payload
        ranking (integer optional): additional filter - payload
        description (string optional): additional filter - payload
        extended_attributes (array object optional): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['uuid_service', 'timestamp', 'status',
        'ranking', 'description', 'extended_attributes']
    payload.get('uuid_service'), payload.get('timestamp'), payload.get(
        'status'), payload.get('ranking'), payload.get('description'
        ), payload.get('extended_attributes')
    if not self._silence_warning:
        warning_wrong_parameters(self.ts_service_status_create.__name__,
            payload, official_payload_list)
    response = self.execute('POST', path=f'/ts_service_status/',
        payload=payload, **kwargs)
    return response

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

Bulk Create Ts Service Status

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_service": "string", required "timestamp": "string", required "status": "None", optional "ranking": "integer", optional "description": "string", optional "extended_attributes": "array object", optional } ]

Returns: list

Source code in hive/cookbook/ts_service_status.py 
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
def ts_service_status_create_bulk(self, payload: list,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None
    ) -> list:
    """Bulk Create Ts Service Status

    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_service": "string", required
        "timestamp": "string", required
        "status": "None", optional
        "ranking": "integer", optional
        "description": "string", optional
        "extended_attributes": "array object", optional
       }
      ]

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

ts_service_status_delete(uuid_service, kwargs=None, **params)

Delete Timeseries Service Status

Parameters:

Name Type Description Default
uuid_service (str, required)

uuid_service

 required
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
ts_start string required

additional filter - parameter
ts_end string required

additional filter - parameter

Returns: list

Source code in hive/cookbook/ts_service_status.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
def ts_service_status_delete(self, uuid_service: str,
    kwargs: dict = None, **params) -> list:
    """Delete Timeseries Service Status

    Args:
        uuid_service (str, required): uuid_service
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        ts_start (string required): additional filter - parameter
        ts_end (string required): additional filter - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['ts_start', 'ts_end']
    params.get('ts_start'), params.get('ts_end')
    if not self._silence_warning:
        warning_wrong_parameters(self.ts_service_status_delete.__name__,
            params, official_params_list)
    response = self.execute('DELETE', path=
        f'/ts_service_status/{uuid_service}/', params=params, **kwargs)
    return response

ts_service_status_delete_bulk(payload, single_page=False, page_size=50, kwargs=None, **params)

Bulk Delete Ts Service Status

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
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
ts_start string required

additional filter - parameter
ts_end string required

additional filter - parameter

Examples:

payload =

[ "uuid": "str", required ]

Returns: list

Source code in hive/cookbook/ts_service_status.py 
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
def ts_service_status_delete_bulk(self, payload: list,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None,
    **params) -> list:
    """Bulk Delete Ts Service Status

    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.
        **params: additional parameters for the API.

    Keyword Args:
        ts_start (string required): additional filter - parameter
        ts_end (string required): additional filter - parameter

    Examples:
        payload = 
      [
        "uuid": "str", required
      ]

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['ts_start', 'ts_end']
    params.get('ts_start'), params.get('ts_end')
    if not self._silence_warning:
        warning_wrong_parameters(self.ts_service_status_delete_bulk.
            __name__, params, official_params_list)
    response = self.execute('POST', path=
        f'/ts_service_status/bulk/delete/', single_page=single_page,
        page_size=page_size, params=params, payload=payload, **kwargs)
    return response

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

Read Services

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_parent string optional

additional filter - parameter
uuid_customer string optional

additional filter - parameter
profile string optional

additional filter - parameter
name string optional

additional filter - parameter
description string optional

additional filter - parameter
status string optional

additional filter - parameter
ts_description string optional

additional filter - parameter
ts_status None optional

additional filter - parameter
ts_timestamp_start string optional

additional filter - parameter
ts_timestamp_end string optional

additional filter - parameter
ts_ranking integer 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/ts_service_status.py 
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
def ts_service_status_query(self, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """Read Services

    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_parent (string optional): additional filter - parameter
        uuid_customer (string optional): additional filter - parameter
        profile (string optional): additional filter - parameter
        name (string optional): additional filter - parameter
        description (string optional): additional filter - parameter
        status (string optional): additional filter - parameter
        ts_description (string optional): additional filter - parameter
        ts_status (None optional): additional filter - parameter
        ts_timestamp_start (string optional): additional filter - parameter
        ts_timestamp_end (string optional): additional filter - parameter
        ts_ranking (integer 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_parent',
        'uuid_customer', 'profile', 'name', 'description', 'status',
        'ts_description', 'ts_status', 'ts_timestamp_start',
        'ts_timestamp_end', 'ts_ranking', 'skip', 'limit', 'like',
        'join', 'count']
    params.get('sort_by'), params.get('null_fields'), params.get(
        'uuid_parent'), params.get('uuid_customer'), params.get('profile'
        ), params.get('name'), params.get('description'), params.get(
        'status'), params.get('ts_description'), params.get('ts_status'
        ), params.get('ts_timestamp_start'), params.get('ts_timestamp_end'
        ), params.get('ts_ranking'), params.get('skip'), params.get('limit'
        ), params.get('like'), params.get('join'), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.ts_service_status_query.__name__,
            params, official_params_list)
    response = self.execute('GET', path=f'/ts_service_status/query/',
        single_page=single_page, page_size=page_size, warm_start=
        warm_start, params=params, **kwargs)
    return response