three.MF.V3.Tasks.RemoveProjects

View Source

 1from MF.V3.Descriptors.Project import Project as MF_V3_Descriptors_Project_Project
 2from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 3from typing import List
 4
 5
 6class RemoveProjects:
 7    """*
 8    Remove selected projects.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"RemoveProjects",
17    "Input":[1,3,6]
18    }
19    }
20    ```
21
22    > Response example:
23
24    ```json
25    {
26    "Task":{
27    "Index":1,
28    "Type":"RemoveProjects",
29    "Input":[1,3,6],
30    "Output":[
31    {"index":2,"modified":[2024,5,12,11,23,17],"name":"Project 2","size":35409834},
32    {"index":4,"modified":[2024,5,12,11,2,37],"name":"Project 4","size":175025367},
33    {"index":5,"modified":[2024,5,6,17,15,53],"name":"Project 5","size":24314083}
34    ],
35    "State":"Completed"
36    }
37    }
38    ```
39    """
40    class Request:
41
42        """
43         Client request for the `RemoveProjects` task.
44        """
45        def __init__(self, Index: int, Type: str, Input: List[int] = None):
46            # A unique identifier generated by the client.
47            self.Index = Index
48            # "RemoveProjects"
49            self.Type = Type
50            # The list of indices of the projects to remove.
51            self.Input = Input
52
53    class Response:
54
55        """
56         Server response for the `RemoveProjects` task.
57        """
58        def __init__(self, Index: int, Type: str, Input: List[int] = None, Output: MF_V3_Descriptors_Project_Project.Brief = None, State: MF_V3_Task_TaskState = None, Error: str = None):
59            # The unique identifier generated by the client.
60            self.Index = Index
61            # "RemoveProjects"
62            self.Type = Type
63            # The list of indices of the requested projects to remove.
64            self.Input = Input
65            # Brief descriptors of the remaining projects.
66            self.Output = Output
67            # The current state of the task.
68            self.State = State
69            # A string describing the error if the task has failed.
70            self.Error = Error
71
72    def __init__(self):
73        pass

class RemoveProjects: View Source

 7class RemoveProjects:
 8    """*
 9    Remove selected projects.
10
11    > Request example:
12
13    ```json
14    {
15    "Task":{
16    "Index":1,
17    "Type":"RemoveProjects",
18    "Input":[1,3,6]
19    }
20    }
21    ```
22
23    > Response example:
24
25    ```json
26    {
27    "Task":{
28    "Index":1,
29    "Type":"RemoveProjects",
30    "Input":[1,3,6],
31    "Output":[
32    {"index":2,"modified":[2024,5,12,11,23,17],"name":"Project 2","size":35409834},
33    {"index":4,"modified":[2024,5,12,11,2,37],"name":"Project 4","size":175025367},
34    {"index":5,"modified":[2024,5,6,17,15,53],"name":"Project 5","size":24314083}
35    ],
36    "State":"Completed"
37    }
38    }
39    ```
40    """
41    class Request:
42
43        """
44         Client request for the `RemoveProjects` task.
45        """
46        def __init__(self, Index: int, Type: str, Input: List[int] = None):
47            # A unique identifier generated by the client.
48            self.Index = Index
49            # "RemoveProjects"
50            self.Type = Type
51            # The list of indices of the projects to remove.
52            self.Input = Input
53
54    class Response:
55
56        """
57         Server response for the `RemoveProjects` task.
58        """
59        def __init__(self, Index: int, Type: str, Input: List[int] = None, Output: MF_V3_Descriptors_Project_Project.Brief = None, State: MF_V3_Task_TaskState = None, Error: str = None):
60            # The unique identifier generated by the client.
61            self.Index = Index
62            # "RemoveProjects"
63            self.Type = Type
64            # The list of indices of the requested projects to remove.
65            self.Input = Input
66            # Brief descriptors of the remaining projects.
67            self.Output = Output
68            # The current state of the task.
69            self.State = State
70            # A string describing the error if the task has failed.
71            self.Error = Error
72
73    def __init__(self):
74        pass

* Remove selected projects.

Request example:

{
"Task":{
"Index":1,
"Type":"RemoveProjects",
"Input":[1,3,6]
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"RemoveProjects",
"Input":[1,3,6],
"Output":[
{"index":2,"modified":[2024,5,12,11,23,17],"name":"Project 2","size":35409834},
{"index":4,"modified":[2024,5,12,11,2,37],"name":"Project 4","size":175025367},
{"index":5,"modified":[2024,5,6,17,15,53],"name":"Project 5","size":24314083}
],
"State":"Completed"
}
}

class RemoveProjects.Request: View Source

41    class Request:
42
43        """
44         Client request for the `RemoveProjects` task.
45        """
46        def __init__(self, Index: int, Type: str, Input: List[int] = None):
47            # A unique identifier generated by the client.
48            self.Index = Index
49            # "RemoveProjects"
50            self.Type = Type
51            # The list of indices of the projects to remove.
52            self.Input = Input

Client request for the RemoveProjects task.

RemoveProjects.Request(Index: int, Type: str, Input: List[int] = None) View Source

46        def __init__(self, Index: int, Type: str, Input: List[int] = None):
47            # A unique identifier generated by the client.
48            self.Index = Index
49            # "RemoveProjects"
50            self.Type = Type
51            # The list of indices of the projects to remove.
52            self.Input = Input

Index

Type

Input

class RemoveProjects.Response: View Source

54    class Response:
55
56        """
57         Server response for the `RemoveProjects` task.
58        """
59        def __init__(self, Index: int, Type: str, Input: List[int] = None, Output: MF_V3_Descriptors_Project_Project.Brief = None, State: MF_V3_Task_TaskState = None, Error: str = None):
60            # The unique identifier generated by the client.
61            self.Index = Index
62            # "RemoveProjects"
63            self.Type = Type
64            # The list of indices of the requested projects to remove.
65            self.Input = Input
66            # Brief descriptors of the remaining projects.
67            self.Output = Output
68            # The current state of the task.
69            self.State = State
70            # A string describing the error if the task has failed.
71            self.Error = Error

Server response for the RemoveProjects task.

RemoveProjects.Response( Index: int, Type: str, Input: List[int] = None, Output: MF.V3.Descriptors.Project.Project.Brief = None, State: MF.V3.Task.TaskState = None, Error: str = None) View Source

59        def __init__(self, Index: int, Type: str, Input: List[int] = None, Output: MF_V3_Descriptors_Project_Project.Brief = None, State: MF_V3_Task_TaskState = None, Error: str = None):
60            # The unique identifier generated by the client.
61            self.Index = Index
62            # "RemoveProjects"
63            self.Type = Type
64            # The list of indices of the requested projects to remove.
65            self.Input = Input
66            # Brief descriptors of the remaining projects.
67            self.Output = Output
68            # The current state of the task.
69            self.State = State
70            # A string describing the error if the task has failed.
71            self.Error = Error

Index

Type

Input

Output

State

Error