# BackupActionResult.Failure

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

*** ** * ** ***


```
public final class BackupActionResult.Failure extends BackupActionResult
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.test.backup.host.BackupActionResult](https://developer.android.com/reference/androidx/test/backup/host/BackupActionResult) ||
|   | ↳ | [androidx.test.backup.host.BackupActionResult.Failure](https://developer.android.com/reference/androidx/test/backup/host/BackupActionResult.Failure) |

*** ** * ** ***

Indicates that the device payload failed during execution or verification.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/test/backup/host/BackupActionResult.Failure#Failure(kotlin.String,kotlin.String,kotlin.collections.Map)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html errorMessage, https://developer.android.com/reference/java/lang/String.html stackTrace, @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> data )` |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/test/backup/host/BackupActionResult.Failure#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `@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/host/BackupActionResult.Failure#getData()()` Data that the action returned, such as values it read on the device. |
| `final @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/host/BackupActionResult.Failure#getErrorMessage()()` The high-level error message or exception summary. |
| `final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/test/backup/host/BackupActionResult.Failure#getStackTrace()()` The optional serialized stack trace of any caught device-side exceptions. |
| `int` | `https://developer.android.com/reference/androidx/test/backup/host/BackupActionResult.Failure#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/host/BackupActionResult.Failure#toString()()` |

### Inherited methods

From [androidx.test.backup.host.BackupActionResult](https://developer.android.com/reference/androidx/test/backup/host/BackupActionResult) `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/host/BackupActionResult#getOrThrow()()`

Returns the `https://developer.android.com/reference/androidx/test/backup/host/BackupActionResult#data()` of a `https://developer.android.com/reference/androidx/test/backup/host/BackupActionResult.Success`, or throws an `https://developer.android.com/reference/java/io/IOException.html` for a `https://developer.android.com/reference/androidx/test/backup/host/BackupActionResult.Failure`, as `https://developer.android.com/reference/androidx/test/backup/host/BackupRestoreController#runBackupRestoreFlow(androidx.test.backup.host.StorageDomain,java.nio.file.Path,androidx.test.backup.host.BackupTransportMode,androidx.test.backup.host.BackupRestoreController)` does when one of its actions fails.
`final boolean` `https://developer.android.com/reference/androidx/test/backup/host/BackupActionResult#isSuccess()()`

Returns true if this is a Success result.

## Public constructors

### Failure

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

```
public Failure(
    @NonNull String errorMessage,
    String stackTrace,
    @NonNull Map<@NonNull String, @NonNull String> data
)
```

## Public methods

### equals

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

### getData

```
public @NonNull Map<@NonNull String, @NonNull String> getData()
```

Data that the action returned, such as values it read on the device. Empty if the action returned none or didn't run to completion. The data of a `https://developer.android.com/reference/androidx/test/backup/host/BackupActionResult.Failure` leaves out the `status` and `error` of the action, which `https://developer.android.com/reference/androidx/test/backup/host/BackupActionResult.Failure#errorMessage()` reports. A result keeps a copy of the data that it's created with.

### getErrorMessage

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

```
public final @NonNull String getErrorMessage()
```

The high-level error message or exception summary.

### getStackTrace

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

```
public final String getStackTrace()
```

The optional serialized stack trace of any caught device-side exceptions.

### hashCode

```
public int hashCode()
```

### toString

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