# 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)

*** ** * ** ***


```
class BackupActionResult.Failure : BackupActionResult
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.test.backup.host.BackupActionResult](https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult) ||
|   | ↳ | [androidx.test.backup.host.BackupActionResult.Failure](https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult.Failure) |

*** ** * ** ***

Indicates that the device payload failed during execution or verification.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult.Failure#Failure(kotlin.String,kotlin.String,kotlin.collections.Map)( errorMessage: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, stackTrace: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, data: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html> )` |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult.Failure#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult.Failure#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult.Failure#toString()()` |

| ### Public properties |
|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html>` | `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult.Failure#data()` Data that the action returned, such as values it read on the device. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult.Failure#errorMessage()` The high-level error message or exception summary. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult.Failure#stackTrace()` The optional serialized stack trace of any caught device-side exceptions. |

### Inherited functions

From [androidx.test.backup.host.BackupActionResult](https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html>` `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult#getOrThrow()()`

Returns the `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult#data()` of a `https://developer.android.com/reference/kotlin/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/kotlin/androidx/test/backup/host/BackupActionResult.Failure`, as `https://developer.android.com/reference/kotlin/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.

### Inherited properties

From [androidx.test.backup.host.BackupActionResult](https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/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)

```
Failure(
    errorMessage: String,
    stackTrace: String? = null,
    data: Map<String, String> = emptyMap()
)
```

## Public functions

### equals

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

### hashCode

```
open fun hashCode(): Int
```

### toString

```
open fun toString(): String
```

## Public properties

### data

```
open val data: Map<String, String>
```

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/kotlin/androidx/test/backup/host/BackupActionResult.Failure` leaves out the `status` and `error` of the action, which `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupActionResult.Failure#errorMessage()` reports. A result keeps a copy of the data that it's created with.

### errorMessage

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

```
val errorMessage: String
```

The high-level error message or exception summary.

### stackTrace

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

```
val stackTrace: String?
```

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