IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

UploadTask.TaskSnapshot

class UploadTask.TaskSnapshot : StorageTask.SnapshotBase

kotlin.Any
↳	com.google.firebase.storage.StorageTask.SnapshotBase
	↳	com.google.firebase.storage.UploadTask.TaskSnapshot

Encapsulates state about the running UploadTask

Summary

Public functions
`Long`	`getBytesTransferred()`
`StorageMetadata?`	`getMetadata()`
`Long`	`getTotalByteCount()`
`Uri?`	`getUploadSessionUri()`

Extension functions
`operator Long`	`UploadTask.TaskSnapshot.component1()` Destructuring declaration for `UploadTask.TaskSnapshot` to provide bytesTransferred.
`operator Long`	`UploadTask.TaskSnapshot.component2()` Destructuring declaration for `UploadTask.TaskSnapshot` to provide totalByteCount.
`operator StorageMetadata?`	`UploadTask.TaskSnapshot.component3()` Destructuring declaration for `UploadTask.TaskSnapshot` to provide its metadata.
`operator Uri?`	`UploadTask.TaskSnapshot.component4()` Destructuring declaration for `UploadTask.TaskSnapshot` to provide its uploadSessionUri.

Inherited functions

From com.google.firebase.storage.StorageTask.SnapshotBase

`Exception?`	`getError()` Returns the last error encountered.
`StorageReference`	`getStorage()` Returns the target of the upload.
`StorageTask<ResultT!>`	`getTask()` Returns the `StorageTask` for this state.

Inherited properties

From com.google.firebase.storage.StorageTask.SnapshotBase

Exception!

error

Public functions

getBytesTransferred

fun getBytesTransferred(): Long

Returns
`Long`	the total bytes uploaded so far.

getMetadata

fun getMetadata(): StorageMetadata?

Returns
`StorageMetadata?`	the metadata for the object. After uploading, this will return the resulting final Metadata which will include the upload URL.

getTotalByteCount

fun getTotalByteCount(): Long

Returns
`Long`	The number of bytes to upload. Will return -1 if uploading from a stream.

getUploadSessionUri

fun getUploadSessionUri(): Uri?

Returns
`Uri?`	the session Uri, valid for approximately one week, which can be used to resume an upload later by passing this value into `putFile`

Extension functions

component1

operator fun UploadTask.TaskSnapshot.component1(): Long

Destructuring declaration for UploadTask.TaskSnapshot to provide bytesTransferred.

Returns
`Long`	the bytesTransferred of the `UploadTask.TaskSnapshot`

component2

operator fun UploadTask.TaskSnapshot.component2(): Long

Destructuring declaration for UploadTask.TaskSnapshot to provide totalByteCount.

Returns
`Long`	the totalByteCount of the `UploadTask.TaskSnapshot`

component3

operator fun UploadTask.TaskSnapshot.component3(): StorageMetadata?

Destructuring declaration for UploadTask.TaskSnapshot to provide its metadata.

Returns
`StorageMetadata?`	the metadata of the `UploadTask.TaskSnapshot`

component4

operator fun UploadTask.TaskSnapshot.component4(): Uri?

Destructuring declaration for UploadTask.TaskSnapshot to provide its uploadSessionUri.

Returns
`Uri?`	the uploadSessionUri of the `UploadTask.TaskSnapshot`