SubmissionMessage¶
Model of Submission Message
| Field | Type | Description | Required | Default |
|---|---|---|---|---|
| msg | Submission | Body of the message | Yes |
None |
| msg_loader | Enum | Class to use to load the message as an object Supported values are: "assemblyline.odm.messages.submission.SubmissionMessage" |
Yes |
assemblyline.odm.messages.submission.SubmissionMessage |
| msg_type | Enum | Type of message Supported values are: "SubmissionCompleted", "SubmissionIngested", "SubmissionReceived", "SubmissionStarted" |
Yes |
None |
| sender | Keyword | Sender of the message | Yes |
None |
Submission¶
Submission Model
| Field | Type | Description | Required | Default |
|---|---|---|---|---|
| sid | UUID | Submission ID to use | Yes |
None |
| time | Date | Message time | Yes |
NOW |
| files | List [File] | File block | Yes |
[] |
| metadata | FlattenedObject | Metadata submitted with the file | Yes |
{} |
| notification | Notification | Notification queue parameters | Yes |
See Notification for more details. |
| params | SubmissionParams | Parameters of the submission | Yes |
None |
| scan_key | Keyword | None | Optional |
None |
Notification¶
Notification Model
| Field | Type | Description | Required | Default |
|---|---|---|---|---|
| queue | Keyword | Queue to publish the completion message | Optional |
None |
| threshold | Integer | Notify only if this score threshold is met | Optional |
None |