three.MF.V3.Tasks.OpenProject

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

* Create a new project.

Request example:

{
"Task":{
"Index":1,
"Type":"OpenProject",
"Input":5
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"OpenProject",
"Input":5,
"Output":{
"index":5,
"name":"Project 5"
}
"State":"Completed"
}
}
class OpenProject.Request:
39    class Request:
40
41        """
42         Client request for the `OpenProject` task.
43        """
44        def __init__(self, Index: int, Type: str, Input: int):
45            # A unique identifier generated by the client.
46            self.Index = Index
47            # "OpenProject"
48            self.Type = Type
49            # The index of the project to open.  Project indices can be obtained from the `ListProjects` task.
50            self.Input = Input

Client request for the OpenProject task.

OpenProject.Request(Index: int, Type: str, Input: int)
44        def __init__(self, Index: int, Type: str, Input: int):
45            # A unique identifier generated by the client.
46            self.Index = Index
47            # "OpenProject"
48            self.Type = Type
49            # The index of the project to open.  Project indices can be obtained from the `ListProjects` task.
50            self.Input = Input
Index
Type
Input
class OpenProject.Response:
52    class Response:
53
54        """
55         Server response for the `OpenProject` task.
56        """
57        def __init__(self, Index: int, Type: str, Input: int, Output: MF_V3_Descriptors_Project_Project = None, State: MF_V3_Task_TaskState = None, Error: str = None):
58            # The unique identifier generated by the client.
59            self.Index = Index
60            # "OpenProject"
61            self.Type = Type
62            # The index of the project requested to open.
63            self.Input = Input
64            # The open project descriptor.
65            self.Output = Output
66            # The current state of the task.
67            self.State = State
68            # A string describing the error if the task has failed.
69            self.Error = Error

Server response for the OpenProject task.

OpenProject.Response( Index: int, Type: str, Input: int, Output: MF.V3.Descriptors.Project.Project = None, State: MF.V3.Task.TaskState = None, Error: str = None)
57        def __init__(self, Index: int, Type: str, Input: int, Output: MF_V3_Descriptors_Project_Project = None, State: MF_V3_Task_TaskState = None, Error: str = None):
58            # The unique identifier generated by the client.
59            self.Index = Index
60            # "OpenProject"
61            self.Type = Type
62            # The index of the project requested to open.
63            self.Input = Input
64            # The open project descriptor.
65            self.Output = Output
66            # The current state of the task.
67            self.State = State
68            # A string describing the error if the task has failed.
69            self.Error = Error
Index
Type
Input
Output
State
Error