Commands
Command structures and base command types used across the platform.
Command Schemas
COMMAND
BaseCommand
Base command structure containing common fields for all commands.
Namespace:
com.matera.dtw.command.base.common
Fields
baseEvent
BaseEvent
This command's meta-data
replyTo
string
The destination topic to reply to
replyKey
string | null
Key used when replying (default: null)
COMMAND
BaseCommandSuccessResult
Base structure for successful command execution results.
Namespace:
com.matera.dtw.command.base.common
Fields
baseEvent
BaseEvent
This command's meta-data
COMMAND
BaseCommandFailureResult
Base structure for failed command execution results.
Namespace:
com.matera.dtw.command.base.common
Fields
baseEvent
BaseEvent
This command's meta-data
failureInfo
FailureInfo
Data related with the underlying failure
COMMAND
FailureInfo
Represent a command execution failure metadata. Loosely based on the RFC7807.
Namespace:
com.matera.dtw.command.base.common
Fields
type
string
A URI reference RFC3986 that identifies the problem type
title
string
A short, human-readable summary of the problem type
details
string | null
A human-readable explanation specific to this occurrence of the problem (default: null)
parameters
json | null
Additional parameters that give more context on the cause of the given errors. Stored on the Json Format (default: null)
COMMAND
ResultStatus
Whether the result is already obtained or is deferred.
Namespace:
com.matera.dtw.command.base.common
Type
type
enum
Result status enumeration
symbols
array
IMMEDIATE, DEFERRED