Skip to content

Hive.cookbook.acl docs

AclDocs

Bases: ApiManager

Class that handles all the XAutomata acl_docs APIs

Source code in hive/cookbook/acl_docs.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
class AclDocs(ApiManager):
    """Class that handles all the XAutomata acl_docs APIs"""

    def acl_docs(self, warm_start: bool = False, kwargs: dict = None) -> list:
        """Read Acl Docs

        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.
            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_docs/', warm_start=
            warm_start, **kwargs)
        return response

acl_docs(warm_start=False, kwargs=None)

Read Acl Docs

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

additional parameters for execute. Default to None.

 None

Returns: list

Source code in hive/cookbook/acl_docs.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
def acl_docs(self, warm_start: bool = False, kwargs: dict = None) -> list:
    """Read Acl Docs

    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.
        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_docs/', warm_start=
        warm_start, **kwargs)
    return response