Skip to content

Hive.cookbook.automata ingest

AutomataIngest

Bases: ApiManager

Class that handles all the XAutomata automata_ingest APIs

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

    def automata_ingest_create(self, kwargs: dict = None, **payload) -> list:
        """Insert Automata

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

        Keyword Args:
            extended_attributes (string optional): additional filter - payload
            uuid_automata_instance (string required): additional filter - payload
            timestamp (integer required): additional filter - payload
            group_label (string optional): additional filter - payload
            xal_name (string optional): additional filter - payload
            automata_name (string optional): additional filter - payload
            automata_version (string optional): additional filter - payload
            current_state (string optional): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['extended_attributes',
            'uuid_automata_instance', 'timestamp', 'group_label',
            'xal_name', 'automata_name', 'automata_version', 'current_state']
        payload.get('extended_attributes'), payload.get(
            'uuid_automata_instance'), payload.get('timestamp'), payload.get(
            'group_label'), payload.get('xal_name'), payload.get(
            'automata_name'), payload.get('automata_version'), payload.get(
            'current_state')
        if not self._silence_warning:
            warning_wrong_parameters(self.automata_ingest_create.__name__,
                payload, official_payload_list)
        response = self.execute('POST', path=f'/automata_ingest/', payload=
            payload, **kwargs)
        return response

automata_ingest_create(kwargs=None, **payload)

Insert Automata

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

additional filter - payload
uuid_automata_instance string required

additional filter - payload
timestamp integer required

additional filter - payload
group_label string optional

additional filter - payload
xal_name string optional

additional filter - payload
automata_name string optional

additional filter - payload
automata_version string optional

additional filter - payload
current_state string optional

additional filter - payload

Returns: list

Source code in hive/cookbook/automata_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
def automata_ingest_create(self, kwargs: dict = None, **payload) -> list:
    """Insert Automata

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

    Keyword Args:
        extended_attributes (string optional): additional filter - payload
        uuid_automata_instance (string required): additional filter - payload
        timestamp (integer required): additional filter - payload
        group_label (string optional): additional filter - payload
        xal_name (string optional): additional filter - payload
        automata_name (string optional): additional filter - payload
        automata_version (string optional): additional filter - payload
        current_state (string optional): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['extended_attributes',
        'uuid_automata_instance', 'timestamp', 'group_label',
        'xal_name', 'automata_name', 'automata_version', 'current_state']
    payload.get('extended_attributes'), payload.get(
        'uuid_automata_instance'), payload.get('timestamp'), payload.get(
        'group_label'), payload.get('xal_name'), payload.get(
        'automata_name'), payload.get('automata_version'), payload.get(
        'current_state')
    if not self._silence_warning:
        warning_wrong_parameters(self.automata_ingest_create.__name__,
            payload, official_payload_list)
    response = self.execute('POST', path=f'/automata_ingest/', payload=
        payload, **kwargs)
    return response