Skip to content

Commit 6c052b4

Browse files
committed
Update cancel_task to add clear unique_id option
1 parent b59920f commit 6c052b4

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

scaleapi/__init__.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,18 +64,22 @@ def get_task(self, task_id: str) -> Task:
6464
endpoint = f"task/{task_id}"
6565
return Task(self.api.get_request(endpoint), self)
6666

67-
def cancel_task(self, task_id: str) -> Task:
67+
def cancel_task(self, task_id: str, clear_unique_id: bool) -> Task:
6868
"""Cancels a task and returns the associated task.
6969
Raises a ScaleException if it has already been canceled.
7070
7171
Args:
7272
task_id (str):
7373
Task id
74-
74+
clear_unique_id (boolean):
75+
Option to clear unique id when the task is deleted
7576
Returns:
7677
Task
7778
"""
78-
endpoint = f"task/{task_id}/cancel"
79+
if clear_unique_id:
80+
endpoint = f"task/{task_id}/cancel?clear_unique_id=true"
81+
else:
82+
endpoint = f"task/{task_id}/cancel"
7983
return Task(self.api.post_request(endpoint), self)
8084

8185
def tasks(self, **kwargs) -> Tasklist:

0 commit comments

Comments
 (0)