BackupActionOutputKeys
object BackupActionOutputKeys
Keys produced in BackupDeviceActionResult.payload by the actions bundled with this library.
STATUS is always present. ERROR is present if and only if STATUS is BackupActionValues.STATUS_FAILURE. Actions may add their own keys alongside these; the host orchestrator forwards the whole payload to the caller.
Prefer BackupDeviceActionResult.success and BackupDeviceActionResult.failure over populating these keys by hand, and BackupDeviceActionResult.isSuccess and BackupDeviceActionResult.errorMessage over reading them by hand.
Input keys live in a separate namespace, BackupActionInputKeys.
Summary
Constants |
|
|---|---|
const String |
Human-readable description of why the action failed. |
const String |
Outcome of the action. |
Constants
ERROR
const val ERROR: String
Human-readable description of why the action failed.
Present if and only if STATUS is BackupActionValues.STATUS_FAILURE.
STATUS
const val STATUS: String
Outcome of the action.
Always one of BackupActionValues.STATUS_SUCCESS or BackupActionValues.STATUS_FAILURE. The outcome is carried as a string rather than a boolean so that further categories, such as a warning or a partial success, can be added without breaking the wire format.