three.MF.V3.Tasks.ExportLogs 

 1from MF.V3.Task import TaskState as MF_V3_Task_TaskState, Task as MF_V3_Task_Task
 2
 3
 4class ExportLogs:
 5    """*
 6    Export scanner logs.
 7
 8    > Request example:
 9
10    ```json
11    {
12    "Task":{
13    "Index":1,
14    "Type":"ExportLogs",
15    "Input":true
16    }
17    }
18    ```
19
20    > Export file buffer message from server.
21
22    ```json
23    {
24    "Buffer":{
25    "Index":0,
26    "Size":41337,
27    "Task":{
28    "Index":1,
29    "Type":"ExportLogs",
30    "Input":true
31    }
32    }
33    }
34    ```
35
36    > Export file binary data transfer from server [41337 bytes].
37
38    > Response example:
39
40    ```json
41    {
42    "Task":{
43    "Index":1,
44    "Type":"ExportLogs"
45    "Input":true,
46    "State":"Completed"
47    }
48    }
49    ```
50    """
51    class Request:
52
53        """
54         Client request for the `ExportLogs` task.
55        """
56        def __init__(self, Index: int, Type: str, Input: bool = None):
57            # A unique identifier generated by the client.
58            self.Index = Index
59            # "ExportLogs"
60            self.Type = Type
61            # Export log images.  If unspecified, log images are not exported.
62            self.Input = Input
63
64    class Response:
65
66        """
67         Server response for the `ExportLogs` task.
68        """
69        def __init__(self, Index: int, Type: str, Input: bool = None, State: MF_V3_Task_TaskState = None, Error: str = None):
70            # The unique identifier generated by the client.
71            self.Index = Index
72            # "ExportLogs"
73            self.Type = Type
74            # Requested export log images.
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 `ExportLogs` task.
85        """
86        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
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 ExportLogs task.
92            self.Task = Task
93
94    def __init__(self):
95        pass
class ExportLogs: 
 5class ExportLogs:
 6    """*
 7    Export scanner logs.
 8
 9    > Request example:
10
11    ```json
12    {
13    "Task":{
14    "Index":1,
15    "Type":"ExportLogs",
16    "Input":true
17    }
18    }
19    ```
20
21    > Export file buffer message from server.
22
23    ```json
24    {
25    "Buffer":{
26    "Index":0,
27    "Size":41337,
28    "Task":{
29    "Index":1,
30    "Type":"ExportLogs",
31    "Input":true
32    }
33    }
34    }
35    ```
36
37    > Export file binary data transfer from server [41337 bytes].
38
39    > Response example:
40
41    ```json
42    {
43    "Task":{
44    "Index":1,
45    "Type":"ExportLogs"
46    "Input":true,
47    "State":"Completed"
48    }
49    }
50    ```
51    """
52    class Request:
53
54        """
55         Client request for the `ExportLogs` task.
56        """
57        def __init__(self, Index: int, Type: str, Input: bool = None):
58            # A unique identifier generated by the client.
59            self.Index = Index
60            # "ExportLogs"
61            self.Type = Type
62            # Export log images.  If unspecified, log images are not exported.
63            self.Input = Input
64
65    class Response:
66
67        """
68         Server response for the `ExportLogs` task.
69        """
70        def __init__(self, Index: int, Type: str, Input: bool = None, State: MF_V3_Task_TaskState = None, Error: str = None):
71            # The unique identifier generated by the client.
72            self.Index = Index
73            # "ExportLogs"
74            self.Type = Type
75            # Requested export log images.
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 `ExportLogs` task.
86        """
87        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
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 ExportLogs task.
93            self.Task = Task
94
95    def __init__(self):
96        pass

* Export scanner logs.

Request example:

{
"Task":{
"Index":1,
"Type":"ExportLogs",
"Input":true
}
}

Export file buffer message from server.

{
"Buffer":{
"Index":0,
"Size":41337,
"Task":{
"Index":1,
"Type":"ExportLogs",
"Input":true
}
}
}

Export file binary data transfer from server [41337 bytes].

Response example:

{
"Task":{
"Index":1,
"Type":"ExportLogs"
"Input":true,
"State":"Completed"
}
}
class ExportLogs.Request: 
52    class Request:
53
54        """
55         Client request for the `ExportLogs` task.
56        """
57        def __init__(self, Index: int, Type: str, Input: bool = None):
58            # A unique identifier generated by the client.
59            self.Index = Index
60            # "ExportLogs"
61            self.Type = Type
62            # Export log images.  If unspecified, log images are not exported.
63            self.Input = Input

Client request for the ExportLogs task.

ExportLogs.Request(Index: int, Type: str, Input: bool = None) 
57        def __init__(self, Index: int, Type: str, Input: bool = None):
58            # A unique identifier generated by the client.
59            self.Index = Index
60            # "ExportLogs"
61            self.Type = Type
62            # Export log images.  If unspecified, log images are not exported.
63            self.Input = Input
Index
Type
Input
class ExportLogs.Response: 
65    class Response:
66
67        """
68         Server response for the `ExportLogs` task.
69        """
70        def __init__(self, Index: int, Type: str, Input: bool = None, State: MF_V3_Task_TaskState = None, Error: str = None):
71            # The unique identifier generated by the client.
72            self.Index = Index
73            # "ExportLogs"
74            self.Type = Type
75            # Requested export log images.
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 ExportLogs task.

ExportLogs.Response( Index: int, Type: str, Input: bool = None, State: MF.V3.Task.TaskState = None, Error: str = None) 
70        def __init__(self, Index: int, Type: str, Input: bool = None, State: MF_V3_Task_TaskState = None, Error: str = None):
71            # The unique identifier generated by the client.
72            self.Index = Index
73            # "ExportLogs"
74            self.Type = Type
75            # Requested export log images.
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 ExportLogs.Buffer: 
82    class Buffer:
83
84        """
85         Server buffer message for the `ExportLogs` task.
86        """
87        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
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 ExportLogs task.
93            self.Task = Task

Server buffer message for the ExportLogs task.

ExportLogs.Buffer(Index: int, Size: int, Task: MF.V3.Task.Task) 
87        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
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 ExportLogs task.
93            self.Task = Task
Index
Size
Task