# BackupTransportMode

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/BackupTransportMode.kt+class:androidx.test.backup.host.BackupTransportMode) Added in [1.0.0-alpha04](https://developer.android.com/jetpack/androidx/releases/test-backup#1.0.0-alpha04)

*** ** * ** ***


```
class BackupTransportMode
```

<br />

*** ** * ** ***

Represents the platform-transport emulation mode utilized during the backup and restore phases.

This class is designed to be non-exhaustive to allow future transport types to be introduced in a binary-compatible manner. Standard pattern-matching `when` expressions on this type must use an explicit `else` fallback branch.

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupTransportMode` | `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupTransportMode#CLOUD_ENCRYPTED()` Simulates a cloud-based backup utilizing secure client-side end-to-end encryption. |
| `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupTransportMode` | `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupTransportMode#CLOUD_UNENCRYPTED()` Simulates standard cloud-based backup without client-side encryption bounds. |
| `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupTransportMode` | `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupTransportMode#DEVICE_TO_DEVICE()` Simulates a physical peer-to-device direct migration (e.g. transfer via USB/Wi-Fi Direct). |
| `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupTransportMode` | `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupTransportMode#LOCAL()` Performs a local, low-latency offline filesystem transport backup. |

| ### 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/BackupTransportMode#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/BackupTransportMode#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupTransportMode#toString()()` |

## Public companion properties

### CLOUD_ENCRYPTED

```
val CLOUD_ENCRYPTED: BackupTransportMode
```

Simulates a cloud-based backup utilizing secure client-side end-to-end encryption.

### CLOUD_UNENCRYPTED

```
val CLOUD_UNENCRYPTED: BackupTransportMode
```

Simulates standard cloud-based backup without client-side encryption bounds.

### DEVICE_TO_DEVICE

```
val DEVICE_TO_DEVICE: BackupTransportMode
```

Simulates a physical peer-to-device direct migration (e.g. transfer via USB/Wi-Fi Direct).

### LOCAL

```
val LOCAL: BackupTransportMode
```

Performs a local, low-latency offline filesystem transport backup.

The backup data stays in the local backup transport of the device. The archive that `https://developer.android.com/reference/kotlin/androidx/test/backup/host/BackupRestoreController#performBackup(androidx.test.backup.host.BackupTransportMode,java.nio.file.Path,java.time.Duration)` returns only marks the backup, so only the same device can restore it. The archive names the device by its ADB serial number, which can change between runs, for example when an emulator starts on another port.

## Public functions

### equals

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

### hashCode

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

### toString

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