# BackupDeviceActionArgs

Artifact: [androidx.test.backup:backup](https://developer.android.com/jetpack/androidx/releases/test-backup) [View Source](https://cs.android.com/search?q=file:androidx/test/backup/BackupDeviceAction.kt+class:androidx.test.backup.BackupDeviceActionArgs) Added in [1.0.0-alpha04](https://developer.android.com/jetpack/androidx/releases/test-backup#1.0.0-alpha04)

*** ** * ** ***


```
public final class BackupDeviceActionArgs
```

<br />

*** ** * ** ***

Arguments passed from the host orchestrator to a `https://developer.android.com/reference/androidx/test/backup/BackupDeviceAction`.

The payload is a flat map of string keys to string values. `https://developer.android.com/reference/androidx/test/backup/BackupActionInputKeys` documents every key the actions bundled with this library understand, and `https://developer.android.com/reference/androidx/test/backup/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 `https://developer.android.com/reference/androidx/test/backup/BackupDeviceAction` implementations may define keys of their own.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/test/backup/BackupDeviceActionArgs#BackupDeviceActionArgs(kotlin.collections.Map)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html> payload )` |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/test/backup/BackupDeviceActionArgs#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/test/backup/BackupDeviceActionArgs#get(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html key)` Returns the argument stored under `https://developer.android.com/reference/androidx/test/backup/BackupDeviceActionArgs#get(kotlin.String)`, or `null` when the host did not supply it. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html>` | `https://developer.android.com/reference/androidx/test/backup/BackupDeviceActionArgs#getPayload()()` key-value arguments for the action, keyed by `https://developer.android.com/reference/androidx/test/backup/BackupActionInputKeys` |
| `int` | `https://developer.android.com/reference/androidx/test/backup/BackupDeviceActionArgs#hashCode()()` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/test/backup/BackupDeviceActionArgs#toString()()` |

## Public constructors

### BackupDeviceActionArgs

Added in [1.0.0-alpha04](https://developer.android.com/jetpack/androidx/releases/test-backup#1.0.0-alpha04)

```
public BackupDeviceActionArgs(
    @NonNull Map<@NonNull String, @NonNull String> payload
)
```

## Public methods

### equals

```
public boolean equals(Object other)
```

### get

Added in [1.0.0-alpha04](https://developer.android.com/jetpack/androidx/releases/test-backup#1.0.0-alpha04)

```
public final String get(@NonNull String key)
```

Returns the argument stored under `https://developer.android.com/reference/androidx/test/backup/BackupDeviceActionArgs#get(kotlin.String)`, or `null` when the host did not supply it.

Any key may be read, so a custom `https://developer.android.com/reference/androidx/test/backup/BackupDeviceAction` can query keys of its own alongside the `https://developer.android.com/reference/androidx/test/backup/BackupActionInputKeys` constants.

### getPayload

Added in [1.0.0-alpha04](https://developer.android.com/jetpack/androidx/releases/test-backup#1.0.0-alpha04)

```
public final @NonNull Map<@NonNull String, @NonNull String> getPayload()
```

key-value arguments for the action, keyed by `https://developer.android.com/reference/androidx/test/backup/BackupActionInputKeys`

### hashCode

```
public int hashCode()
```

### toString

```
public @NonNull String toString()
```