Skip to content

Hive.cookbook.acl overrides

AclOverrides

Bases: ApiManager

Class that handles all the XAutomata acl_overrides APIs

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

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

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

    def acl_overrides_create(self, kwargs: dict = None, **payload) -> list:
        """Create Acl Override

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

        Keyword Args:
            code (string required): additional filter - payload
            acl_override (array object required): additional filter - payload

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

    def acl_override(self, uuid: str, warm_start: bool = False,
        kwargs: dict = None) -> list:
        """Read Acl Override By Uuid

        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'/acl_overrides/{uuid}',
            warm_start=warm_start, **kwargs)
        return response

    def acl_overrides_put(self, uuid: str, kwargs: dict = None, **payload
        ) -> list:
        """Update Acl Override

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

        Keyword Args:
            code (string optional): additional filter - payload
            acl_override (array object optional): additional filter - payload

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

    def acl_overrides_delete(self, uuid: str, kwargs: dict = None) -> list:
        """Delete Acl Override

        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'/acl_overrides/{uuid}', **
            kwargs)
        return response

    def acl_overrides_users(self, uuid: str, warm_start: bool = False,
        single_page: bool = False, page_size: int = 5000,
        kwargs: dict = None, **params) -> list:
        """List Acl Users

        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.
            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:
            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 = ['skip', 'limit', 'like', 'join', 'count']
        params.get('skip'), params.get('limit'), params.get('like'
            ), params.get('join'), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.acl_overrides_users.__name__,
                params, official_params_list)
        response = self.execute('GET', path=f'/acl_overrides/{uuid}/users',
            single_page=single_page, page_size=page_size, warm_start=
            warm_start, params=params, **kwargs)
        return response

    def acl_overrides_users_create(self, uuid: str, name: str,
        kwargs: dict = None) -> list:
        """Create Acl Override Link With User

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

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

    def acl_overrides_users_delete(self, uuid: str, name: str,
        kwargs: dict = None) -> list:
        """Delete Acl Override Link With User

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

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

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

Read Acl Override By Uuid

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/acl_overrides.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
def acl_override(self, uuid: str, warm_start: bool = False,
    kwargs: dict = None) -> list:
    """Read Acl Override By Uuid

    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'/acl_overrides/{uuid}',
        warm_start=warm_start, **kwargs)
    return response

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

Read Acl Overrides

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

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

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

acl_overrides_create(kwargs=None, **payload)

Create Acl Override

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
code string required

additional filter - payload
acl_override array object required

additional filter - payload

Returns: list

Source code in hive/cookbook/acl_overrides.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def acl_overrides_create(self, kwargs: dict = None, **payload) -> list:
    """Create Acl Override

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

    Keyword Args:
        code (string required): additional filter - payload
        acl_override (array object required): additional filter - payload

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

acl_overrides_delete(uuid, kwargs=None)

Delete Acl Override

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/acl_overrides.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
def acl_overrides_delete(self, uuid: str, kwargs: dict = None) -> list:
    """Delete Acl Override

    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'/acl_overrides/{uuid}', **
        kwargs)
    return response

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

Update Acl Override

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

additional filter - payload
acl_override array object optional

additional filter - payload

Returns: list

Source code in hive/cookbook/acl_overrides.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
def acl_overrides_put(self, uuid: str, kwargs: dict = None, **payload
    ) -> list:
    """Update Acl Override

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

    Keyword Args:
        code (string optional): additional filter - payload
        acl_override (array object optional): additional filter - payload

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

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

List Acl Users

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
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
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/acl_overrides.py 
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
def acl_overrides_users(self, uuid: str, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """List Acl Users

    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.
        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:
        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 = ['skip', 'limit', 'like', 'join', 'count']
    params.get('skip'), params.get('limit'), params.get('like'
        ), params.get('join'), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.acl_overrides_users.__name__,
            params, official_params_list)
    response = self.execute('GET', path=f'/acl_overrides/{uuid}/users',
        single_page=single_page, page_size=page_size, warm_start=
        warm_start, params=params, **kwargs)
    return response

acl_overrides_users_create(uuid, name, kwargs=None)

Create Acl Override Link With User

Parameters:

Name Type Description Default
uuid (str, required)

uuid

 required
name (str, required)

name

 required
kwargs dict

additional parameters for execute. Default to None.

 None

Returns: list

Source code in hive/cookbook/acl_overrides.py 
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
def acl_overrides_users_create(self, uuid: str, name: str,
    kwargs: dict = None) -> list:
    """Create Acl Override Link With User

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

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

acl_overrides_users_delete(uuid, name, kwargs=None)

Delete Acl Override Link With User

Parameters:

Name Type Description Default
uuid (str, required)

uuid

 required
name (str, required)

name

 required
kwargs dict

additional parameters for execute. Default to None.

 None

Returns: list

Source code in hive/cookbook/acl_overrides.py 
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
def acl_overrides_users_delete(self, uuid: str, name: str,
    kwargs: dict = None) -> list:
    """Delete Acl Override Link With User

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

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