BackupActionOutputKeys

Kotlin |Java

public static class 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
`static final @NonNull String`	`ERROR` Human-readable description of why the action failed.
`static final @NonNull String`	`STATUS` Outcome of the action.

Public fields
`static @NonNull BackupActionOutputKeys`	`INSTANCE`

Constants

ERROR

Added in 1.0.0-alpha02

public static final @NonNull String ERROR

Human-readable description of why the action failed.

Present if and only if STATUS is BackupActionValues.STATUS_FAILURE.

STATUS

Added in 1.0.0-alpha02

public static final @NonNull String STATUS

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.

Public fields

INSTANCE

Added in 1.0.0-alpha02

public static @NonNull BackupActionOutputKeys INSTANCE