Skip to content

ThreadService

ThreadService(rest)

Bases: ObjectService

Service to work with Threads in TM1 Deprecated as of TM1 Server v12

Source code in TM1py/Services/ThreadService.py 
17
18
19
20
21
def __init__(self, rest: RestService):
    super().__init__(rest)
    if verify_version(required_version="12.0.0", version=self.version):
        # warn only due to use in Monitoring Service
        warn("Threads not available in this version of TM1, removed as of 12.0.0", DeprecationWarning, 2)

cancel(thread_id, **kwargs)

Kill a running thread

Parameters:

Name Type Description Default
thread_id int
required

Returns:

Type Description
Response
Source code in TM1py/Services/ThreadService.py 
45
46
47
48
49
50
51
52
53
54
@deprecated_in_version(version="12.0.0")
def cancel(self, thread_id: int, **kwargs) -> Response:
    """Kill a running thread

    :param thread_id:
    :return:
    """
    url = format_url("/Threads('{}')/tm1.CancelOperation", str(thread_id))
    response = self._rest.POST(url, **kwargs)
    return response

cancel_all_running(**kwargs)

Source code in TM1py/Services/ThreadService.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
@deprecated_in_version(version="12.0.0")
def cancel_all_running(self, **kwargs) -> list:
    running_threads = self.get_all(**kwargs)
    canceled_threads = list()
    for thread in running_threads:
        if thread["State"] == "Idle":
            continue
        if thread["Type"] == "System":
            continue
        if thread["Name"] == "Pseudo":
            continue
        if thread["Function"] == "GET /Threads":
            continue
        if thread["Function"] == "GET /api/v1/Threads":
            continue
        self.cancel(thread["ID"], **kwargs)
        canceled_threads.append(thread)
    return canceled_threads

get_active(**kwargs)

Return a list of non-idle threads from the TM1 Server

Returns:

Type Description

list: TM1 threads as dict
Source code in TM1py/Services/ThreadService.py 
34
35
36
37
38
39
40
41
42
43
@deprecated_in_version(version="12.0.0")
def get_active(self, **kwargs):
    """Return a list of non-idle threads from the TM1 Server

    :return:
        list: TM1 threads as dict
    """
    url = "/Threads?$filter=Function ne 'GET /Threads' and State ne 'Idle'"
    response = self._rest.GET(url, **kwargs)
    return response.json()["value"]

get_all(**kwargs)

Return a list of the currently running threads from the TM1 Server

Returns:

Type Description
List

dict: the response
Source code in TM1py/Services/ThreadService.py 
23
24
25
26
27
28
29
30
31
32
@deprecated_in_version(version="12.0.0")
def get_all(self, **kwargs) -> List:
    """Return a list of the currently running threads from the TM1 Server

    :return:
        dict: the response
    """
    url = "/Threads"
    response = self._rest.GET(url, **kwargs)
    return response.json()["value"]