BackupDeviceActionArgs


public final 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

Public methods

boolean
equals(Object other)
final String

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

final @NonNull Map<@NonNull String, @NonNull String>

key-value arguments for the action, keyed by BackupActionInputKeys

int
@NonNull String

Public constructors

BackupDeviceActionArgs

Added in 1.0.0-alpha02
public BackupDeviceActionArgs(
    @NonNull Map<@NonNull String, @NonNull String> payload
)

Public methods

equals

public boolean equals(Object other)

get

Added in 1.0.0-alpha02
public final String get(@NonNull String key)

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.

getPayload

Added in 1.0.0-alpha02
public final @NonNull Map<@NonNull String, @NonNull String> getPayload()

key-value arguments for the action, keyed by BackupActionInputKeys

hashCode

public int hashCode()

toString

public @NonNull String toString()