three.MF.V3.Tasks.DownloadProject

View Source

 1from MF.V3.Task import TaskState as MF_V3_Task_TaskState, Task as MF_V3_Task_Task
 2
 3
 4class DownloadProject:
 5    """*
 6    Download a project from the scanner.
 7
 8    > Request example:
 9
10    ```json
11    {
12    "Task":{
13    "Index":1,
14    "Type":"DownloadProject",
15    "Input":5
16    }
17    }
18    ```
19
20    > Buffer message from server.
21
22    ```json
23    {
24    "Buffer":{
25    "Descriptor":"Project-5.zip",
26    "Index":0,
27    "Size":15682096,
28    "Task":{
29    "Index":1,
30    "Type":"DownloadProject",
31    "Input":5
32    }
33    }
34    }
35    ```
36
37    > Binary data transfer from server: The project zip file [15682096 bytes].
38    > Response example:
39
40    ```json
41    {
42    "Task":{
43    "Index":1,
44    "Type":"DownloadProject"
45    "Input":5,
46    "State":"Completed"
47    }
48    }
49    ```
50    """
51    class Request:
52
53        """
54         Client request for the `DownloadProject` task.
55        """
56        def __init__(self, Index: int, Type: str, Input: int):
57            # A unique identifier generated by the client.
58            self.Index = Index
59            # "DownloadProject"
60            self.Type = Type
61            # Index of the project to download.
62            self.Input = Input
63
64    class Response:
65
66        """
67         Server response for the `DownloadProject` task.
68        """
69        def __init__(self, Index: int, Type: str, Input: int, State: MF_V3_Task_TaskState = None, Error: str = None):
70            # The unique identifier generated by the client.
71            self.Index = Index
72            # "DownloadProject"
73            self.Type = Type
74            # Requested index of the project to download.
75            self.Input = Input
76            # The current state of the task.
77            self.State = State
78            # A string describing the error if the task has failed.
79            self.Error = Error
80
81    class Buffer:
82
83        """
84         Server buffer message for the `DownloadProject` task.
85        """
86        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: str):
87            # The zero-based index identifying the data buffer.
88            self.Index = Index
89            # The size of the incoming data buffer in bytes.
90            self.Size = Size
91            # The requested DownloadProject task.
92            self.Task = Task
93            # The downloaded project filename.
94            self.Descriptor = Descriptor
95
96    def __init__(self):
97        pass

class DownloadProject: View Source

 5class DownloadProject:
 6    """*
 7    Download a project from the scanner.
 8
 9    > Request example:
10
11    ```json
12    {
13    "Task":{
14    "Index":1,
15    "Type":"DownloadProject",
16    "Input":5
17    }
18    }
19    ```
20
21    > Buffer message from server.
22
23    ```json
24    {
25    "Buffer":{
26    "Descriptor":"Project-5.zip",
27    "Index":0,
28    "Size":15682096,
29    "Task":{
30    "Index":1,
31    "Type":"DownloadProject",
32    "Input":5
33    }
34    }
35    }
36    ```
37
38    > Binary data transfer from server: The project zip file [15682096 bytes].
39    > Response example:
40
41    ```json
42    {
43    "Task":{
44    "Index":1,
45    "Type":"DownloadProject"
46    "Input":5,
47    "State":"Completed"
48    }
49    }
50    ```
51    """
52    class Request:
53
54        """
55         Client request for the `DownloadProject` task.
56        """
57        def __init__(self, Index: int, Type: str, Input: int):
58            # A unique identifier generated by the client.
59            self.Index = Index
60            # "DownloadProject"
61            self.Type = Type
62            # Index of the project to download.
63            self.Input = Input
64
65    class Response:
66
67        """
68         Server response for the `DownloadProject` task.
69        """
70        def __init__(self, Index: int, Type: str, Input: int, State: MF_V3_Task_TaskState = None, Error: str = None):
71            # The unique identifier generated by the client.
72            self.Index = Index
73            # "DownloadProject"
74            self.Type = Type
75            # Requested index of the project to download.
76            self.Input = Input
77            # The current state of the task.
78            self.State = State
79            # A string describing the error if the task has failed.
80            self.Error = Error
81
82    class Buffer:
83
84        """
85         Server buffer message for the `DownloadProject` task.
86        """
87        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: str):
88            # The zero-based index identifying the data buffer.
89            self.Index = Index
90            # The size of the incoming data buffer in bytes.
91            self.Size = Size
92            # The requested DownloadProject task.
93            self.Task = Task
94            # The downloaded project filename.
95            self.Descriptor = Descriptor
96
97    def __init__(self):
98        pass

* Download a project from the scanner.

Request example:

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

Buffer message from server.

{
"Buffer":{
"Descriptor":"Project-5.zip",
"Index":0,
"Size":15682096,
"Task":{
"Index":1,
"Type":"DownloadProject",
"Input":5
}
}
}

Binary data transfer from server: The project zip file [15682096 bytes]. Response example:

{
"Task":{
"Index":1,
"Type":"DownloadProject"
"Input":5,
"State":"Completed"
}
}

class DownloadProject.Request: View Source

52    class Request:
53
54        """
55         Client request for the `DownloadProject` task.
56        """
57        def __init__(self, Index: int, Type: str, Input: int):
58            # A unique identifier generated by the client.
59            self.Index = Index
60            # "DownloadProject"
61            self.Type = Type
62            # Index of the project to download.
63            self.Input = Input

Client request for the DownloadProject task.

DownloadProject.Request(Index: int, Type: str, Input: int) View Source

57        def __init__(self, Index: int, Type: str, Input: int):
58            # A unique identifier generated by the client.
59            self.Index = Index
60            # "DownloadProject"
61            self.Type = Type
62            # Index of the project to download.
63            self.Input = Input

Index

Type

Input

class DownloadProject.Response: View Source

65    class Response:
66
67        """
68         Server response for the `DownloadProject` task.
69        """
70        def __init__(self, Index: int, Type: str, Input: int, State: MF_V3_Task_TaskState = None, Error: str = None):
71            # The unique identifier generated by the client.
72            self.Index = Index
73            # "DownloadProject"
74            self.Type = Type
75            # Requested index of the project to download.
76            self.Input = Input
77            # The current state of the task.
78            self.State = State
79            # A string describing the error if the task has failed.
80            self.Error = Error

Server response for the DownloadProject task.

DownloadProject.Response( Index: int, Type: str, Input: int, State: MF.V3.Task.TaskState = None, Error: str = None) View Source

70        def __init__(self, Index: int, Type: str, Input: int, State: MF_V3_Task_TaskState = None, Error: str = None):
71            # The unique identifier generated by the client.
72            self.Index = Index
73            # "DownloadProject"
74            self.Type = Type
75            # Requested index of the project to download.
76            self.Input = Input
77            # The current state of the task.
78            self.State = State
79            # A string describing the error if the task has failed.
80            self.Error = Error

Index

Type

Input

State

Error

class DownloadProject.Buffer: View Source

82    class Buffer:
83
84        """
85         Server buffer message for the `DownloadProject` task.
86        """
87        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: str):
88            # The zero-based index identifying the data buffer.
89            self.Index = Index
90            # The size of the incoming data buffer in bytes.
91            self.Size = Size
92            # The requested DownloadProject task.
93            self.Task = Task
94            # The downloaded project filename.
95            self.Descriptor = Descriptor

Server buffer message for the DownloadProject task.

DownloadProject.Buffer(Index: int, Size: int, Task: MF.V3.Task.Task, Descriptor: str) View Source

87        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: str):
88            # The zero-based index identifying the data buffer.
89            self.Index = Index
90            # The size of the incoming data buffer in bytes.
91            self.Size = Size
92            # The requested DownloadProject task.
93            self.Task = Task
94            # The downloaded project filename.
95            self.Descriptor = Descriptor

Index

Size

Task

Descriptor