# FailureRetention

# FailureRetention

```
@Incubating interface FailureRetention : EmulatorSnapshots
```

|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| [com.android.build.api.dsl.FailureRetention](https://developer.android.com/reference/tools/gradle-api/7.1/com/android/build/api/dsl/FailureRetention#) |

Options for configuring Android Test Retention.

When enabled, Android Test Retention automatically takes emulator snapshots on test failures.

## Summary

| ### Inherited functions ||
|---|---|
| From class[EmulatorSnapshots](https://developer.android.com/reference/tools/gradle-api/7.1/com/android/build/api/dsl/EmulatorSnapshots) |------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [retainAll](https://developer.android.com/reference/tools/gradle-api/7.1/com/android/build/api/dsl/EmulatorSnapshots#retainAll())`()` <br /> Call this function to take unlimited number of test failure snapshots (will ignore maxSnapshotsForTestFailures setting) <br /> | ||

|                                                                                                                   ### Properties                                                                                                                   ||
|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| abstract[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [enable](https://developer.android.com/reference/tools/gradle-api/7.1/com/android/build/api/dsl/FailureRetention#enable:kotlin.Boolean) <br />         |
| abstract[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)         | [maxSnapshots](https://developer.android.com/reference/tools/gradle-api/7.1/com/android/build/api/dsl/FailureRetention#maxSnapshots:kotlin.Int) <br /> |

| ### Inherited properties ||
|---|---|
| From class[EmulatorSnapshots](https://developer.android.com/reference/tools/gradle-api/7.1/com/android/build/api/dsl/EmulatorSnapshots) |------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [compressSnapshots](https://developer.android.com/reference/tools/gradle-api/7.1/com/android/build/api/dsl/EmulatorSnapshots#compressSnapshots:kotlin.Boolean) <br /> Enables snapshot compression. Default to false. <br />                                                                                                                                    | | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [enableForTestFailures](https://developer.android.com/reference/tools/gradle-api/7.1/com/android/build/api/dsl/EmulatorSnapshots#enableForTestFailures:kotlin.Boolean) <br /> Enables automated test failure snapshots. Default to false. <br />                                                                                                                | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)         | [maxSnapshotsForTestFailures](https://developer.android.com/reference/tools/gradle-api/7.1/com/android/build/api/dsl/EmulatorSnapshots#maxSnapshotsForTestFailures:kotlin.Int) <br /> Maximum number of failures that would be snapshotted. Any failures after the first $maxSnapshotsForTestFailures will not have snapshots. Default to 2. Must be \>0 <br /> | ||

## Properties

### enable

```
abstract var enable: Boolean
```

**Deprecated.**  

### maxSnapshots

```
abstract var maxSnapshots: Int
```

**Deprecated.**