Skip to content

Hive.cookbook.files

Files

Bases: ApiManager

Class that handles all the XAutomata files APIs

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

    def files(self, warm_start: bool = False, single_page: bool = False,
        page_size: int = 5000, kwargs: dict = None, **params) -> list:
        """List User Files

        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
            name (string optional): additional filter - parameter
            username (string optional): additional filter - parameter
            uuid_service (string optional): additional filter - parameter
            type (string optional): additional filter - parameter
            start_ts (string optional): additional filter - parameter
            end_ts (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', 'name', 'username',
            'uuid_service', 'type', 'start_ts', 'end_ts', 'skip', 'limit',
            'like', 'join', 'count']
        params.get('sort_by'), params.get('name'), params.get('username'
            ), params.get('uuid_service'), params.get('type'), params.get(
            'start_ts'), params.get('end_ts'), params.get('skip'), params.get(
            'limit'), params.get('like'), params.get('join'), params.get(
            'count')
        if not self._silence_warning:
            warning_wrong_parameters(self.files.__name__, params,
                official_params_list)
        response = self.execute('GET', path=f'/files/', single_page=
            single_page, page_size=page_size, warm_start=warm_start, params
            =params, **kwargs)
        return response

    def files_create(self, params: dict = False, kwargs: dict = None, **payload
        ) -> list:
        """Post User File

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

        Keyword Args:
            uuid_service (string optional): additional filter - parameter
            expires_at (string optional): additional filter - parameter
            file (string required): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['file']
        payload.get('file')
        if not self._silence_warning:
            warning_wrong_parameters(self.files_create.__name__, payload,
                official_payload_list)
        response = self.execute('POST', path=f'/files/', params=params,
            payload=payload, **kwargs)
        return response

    def file(self, uuid: str, warm_start: bool = False, kwargs: dict = None
        ) -> list:
        """Read User File

        Args:
            uuid (str, required): uuid
            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.
            kwargs (dict, optional): additional parameters for execute. Default to None.

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        response = self.execute('GET', path=f'/files/{uuid}', warm_start=
            warm_start, **kwargs)
        return response

    def files_put(self, uuid: str, kwargs: dict = None, **payload) -> list:
        """Update Expire User File

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

        Keyword Args:
            uuid_service (string optional): additional filter - payload
            expires_at (string required): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['uuid_service', 'expires_at']
        payload.get('uuid_service'), payload.get('expires_at')
        if not self._silence_warning:
            warning_wrong_parameters(self.files_put.__name__, payload,
                official_payload_list)
        response = self.execute('PUT', path=f'/files/{uuid}', payload=
            payload, **kwargs)
        return response

    def files_delete(self, uuid: str, kwargs: dict = None) -> list:
        """Delete User File

        Args:
            uuid (str, required): uuid
            kwargs (dict, optional): additional parameters for execute. Default to None.

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        response = self.execute('DELETE', path=f'/files/{uuid}', **kwargs)
        return response

    def files_reset_put(self, uuid: str, kwargs: dict = None) -> list:
        """Reset Expire User File

        Args:
            uuid (str, required): uuid
            kwargs (dict, optional): additional parameters for execute. Default to None.

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        response = self.execute('PUT', path=f'/files/{uuid}/reset', **kwargs)
        return response

    def files_download(self, uuid: str, warm_start: bool = False,
        kwargs: dict = None) -> list:
        """Download User File

        Args:
            uuid (str, required): uuid
            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.
            kwargs (dict, optional): additional parameters for execute. Default to None.

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        response = self.execute('GET', path=f'/files/{uuid}/download',
            warm_start=warm_start, **kwargs)
        return response

file(uuid, warm_start=False, kwargs=None)

Read User File

Parameters:

Name Type Description Default
uuid (str, required)

uuid

 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
kwargs dict

additional parameters for execute. Default to None.

 None

Returns: list

Source code in hive/cookbook/files.py 
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
def file(self, uuid: str, warm_start: bool = False, kwargs: dict = None
    ) -> list:
    """Read User File

    Args:
        uuid (str, required): uuid
        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.
        kwargs (dict, optional): additional parameters for execute. Default to None.

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    response = self.execute('GET', path=f'/files/{uuid}', warm_start=
        warm_start, **kwargs)
    return response

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

List User Files

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

additional filter - parameter
username string optional

additional filter - parameter
uuid_service string optional

additional filter - parameter
type string optional

additional filter - parameter
start_ts string optional

additional filter - parameter
end_ts 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/files.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
def files(self, warm_start: bool = False, single_page: bool = False,
    page_size: int = 5000, kwargs: dict = None, **params) -> list:
    """List User Files

    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
        name (string optional): additional filter - parameter
        username (string optional): additional filter - parameter
        uuid_service (string optional): additional filter - parameter
        type (string optional): additional filter - parameter
        start_ts (string optional): additional filter - parameter
        end_ts (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', 'name', 'username',
        'uuid_service', 'type', 'start_ts', 'end_ts', 'skip', 'limit',
        'like', 'join', 'count']
    params.get('sort_by'), params.get('name'), params.get('username'
        ), params.get('uuid_service'), params.get('type'), params.get(
        'start_ts'), params.get('end_ts'), params.get('skip'), params.get(
        'limit'), params.get('like'), params.get('join'), params.get(
        'count')
    if not self._silence_warning:
        warning_wrong_parameters(self.files.__name__, params,
            official_params_list)
    response = self.execute('GET', path=f'/files/', single_page=
        single_page, page_size=page_size, warm_start=warm_start, params
        =params, **kwargs)
    return response

files_create(params=False, kwargs=None, **payload)

Post User File

Parameters:

Name Type Description Default
params dict

additional parameters for the API.

 False
kwargs dict

additional parameters for execute. Default to None.

 None
**payload

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
uuid_service string optional

additional filter - parameter
expires_at string optional

additional filter - parameter
file string required

additional filter - payload

Returns: list

Source code in hive/cookbook/files.py 
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
def files_create(self, params: dict = False, kwargs: dict = None, **payload
    ) -> list:
    """Post User File

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

    Keyword Args:
        uuid_service (string optional): additional filter - parameter
        expires_at (string optional): additional filter - parameter
        file (string required): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['file']
    payload.get('file')
    if not self._silence_warning:
        warning_wrong_parameters(self.files_create.__name__, payload,
            official_payload_list)
    response = self.execute('POST', path=f'/files/', params=params,
        payload=payload, **kwargs)
    return response

files_delete(uuid, kwargs=None)

Delete User File

Parameters:

Name Type Description Default
uuid (str, required)

uuid

 required
kwargs dict

additional parameters for execute. Default to None.

 None

Returns: list

Source code in hive/cookbook/files.py 
117
118
119
120
121
122
123
124
125
126
127
128
def files_delete(self, uuid: str, kwargs: dict = None) -> list:
    """Delete User File

    Args:
        uuid (str, required): uuid
        kwargs (dict, optional): additional parameters for execute. Default to None.

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    response = self.execute('DELETE', path=f'/files/{uuid}', **kwargs)
    return response

files_download(uuid, warm_start=False, kwargs=None)

Download User File

Parameters:

Name Type Description Default
uuid (str, required)

uuid

 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
kwargs dict

additional parameters for execute. Default to None.

 None

Returns: list

Source code in hive/cookbook/files.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
def files_download(self, uuid: str, warm_start: bool = False,
    kwargs: dict = None) -> list:
    """Download User File

    Args:
        uuid (str, required): uuid
        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.
        kwargs (dict, optional): additional parameters for execute. Default to None.

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    response = self.execute('GET', path=f'/files/{uuid}/download',
        warm_start=warm_start, **kwargs)
    return response

files_put(uuid, kwargs=None, **payload)

Update Expire User File

Parameters:

Name Type Description Default
uuid (str, required)

uuid

 required
kwargs dict

additional parameters for execute. Default to None.

 None
**payload

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
uuid_service string optional

additional filter - payload
expires_at string required

additional filter - payload

Returns: list

Source code in hive/cookbook/files.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
def files_put(self, uuid: str, kwargs: dict = None, **payload) -> list:
    """Update Expire User File

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

    Keyword Args:
        uuid_service (string optional): additional filter - payload
        expires_at (string required): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['uuid_service', 'expires_at']
    payload.get('uuid_service'), payload.get('expires_at')
    if not self._silence_warning:
        warning_wrong_parameters(self.files_put.__name__, payload,
            official_payload_list)
    response = self.execute('PUT', path=f'/files/{uuid}', payload=
        payload, **kwargs)
    return response

files_reset_put(uuid, kwargs=None)

Reset Expire User File

Parameters:

Name Type Description Default
uuid (str, required)

uuid

 required
kwargs dict

additional parameters for execute. Default to None.

 None

Returns: list

Source code in hive/cookbook/files.py 
130
131
132
133
134
135
136
137
138
139
140
141
def files_reset_put(self, uuid: str, kwargs: dict = None) -> list:
    """Reset Expire User File

    Args:
        uuid (str, required): uuid
        kwargs (dict, optional): additional parameters for execute. Default to None.

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    response = self.execute('PUT', path=f'/files/{uuid}/reset', **kwargs)
    return response