BackupDeviceActionArgs

Kotlin |Java

class BackupDeviceActionArgs

Arguments passed from the host orchestrator to a BackupDeviceAction.

The payload is a flat map of string keys to string values. BackupActionInputKeys documents every key the actions bundled with this library understand, and BackupActionValues documents the values those keys accept. Keys an action does not recognize are ignored, so one payload can drive both phases of a flow. Custom BackupDeviceAction implementations may define keys of their own.

Summary

Public constructors
`BackupDeviceActionArgs(payload: Map<String, String>)`

Public functions
`open operator Boolean`	`equals(other: Any?)`
`operator String?`	`get(key: String)` Returns the argument stored under `key`, or `null` when the host did not supply it.
`open Int`	`hashCode()`
`open String`	`toString()`

Public properties
`Map<String, String>`	`payload` key-value arguments for the action, keyed by `BackupActionInputKeys`

Public constructors

BackupDeviceActionArgs

Added in 1.0.0-alpha02

BackupDeviceActionArgs(payload: Map<String, String> = emptyMap())

Public functions

equals

open operator fun equals(other: Any?): Boolean

get

Added in 1.0.0-alpha02

operator fun get(key: String): String?

Returns the argument stored under key, or null when the host did not supply it.

Any key may be read, so a custom BackupDeviceAction can query keys of its own alongside the BackupActionInputKeys constants.

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

payload

Added in 1.0.0-alpha02

val payload: Map<String, String>

key-value arguments for the action, keyed by BackupActionInputKeys