StorageReference
classStorageReference :Comparable
Represents a reference to a Google Cloud Storage object. Developers can upload and download objects, get/set object metadata, and delete an object at a specified path. (seeGoogle Cloud Storage)
Summary
Public functions | |
|---|---|
StorageReference | Returns a new instance of |
Int | compareTo(other: StorageReference) |
Task<Void!> | delete()Deletes the object at this |
Boolean | |
(Mutable)List<FileDownloadTask!> | |
(Mutable)List<UploadTask!> | |
String | Return the Google Cloud Storage bucket that holds this object. |
Task<ByteArray<Byte>!> | Asynchronously downloads the object from this |
Task<Uri!> | Asynchronously retrieves a long lived download URL with a revokable token. |
FileDownloadTask | Asynchronously downloads the object at this |
FileDownloadTask | Asynchronously downloads the object at this |
Task<StorageMetadata!> | Retrieves metadata associated with an object at this |
String | getName()Returns the short name of this object. |
StorageReference? | Returns a new instance of |
String | getPath()Returns the full path to this object, not including the Google Cloud Storage bucket. |
StorageReference | getRoot()Returns a new instance of |
FirebaseStorage | Returns the |
StreamDownloadTask | Asynchronously downloads the object at this |
StreamDownloadTask | getStream(processor: StreamDownloadTask.StreamProcessor)Asynchronously downloads the object at this |
Int | hashCode() |
Task<ListResult!> | List up to |
Task<ListResult!> | Resumes a previous call to |
Task<ListResult!> | listAll()List all items (files) and prefixes (folders) under this StorageReference. |
UploadTask | Asynchronously uploads byte data to this |
UploadTask | putBytes(bytes: ByteArray, metadata: StorageMetadata)Asynchronously uploads byte data to this |
UploadTask | Asynchronously uploads from a content URI to this |
UploadTask | putFile(uri: Uri, metadata: StorageMetadata)Asynchronously uploads from a content URI to this |
UploadTask | putFile(uri: Uri, metadata: StorageMetadata?, existingUploadUri: Uri?)Asynchronously uploads from a content URI to this |
UploadTask | putStream(stream: InputStream)Asynchronously uploads a stream of data to this |
UploadTask | putStream(stream: InputStream, metadata: StorageMetadata)Asynchronously uploads a stream of data to this |
String! | toString() |
Task<StorageMetadata!> | updateMetadata(metadata: StorageMetadata)Updates the metadata associated with this |
Public functions
child
fun child(pathString: String): StorageReference
Returns a new instance ofStorageReference pointing to a child location of the current reference. All leading and trailing slashes will be removed, and consecutive slashes will be compressed to single slashes. For example:
child=/foo/barpath=foo/barchild=foo/bar/path=foo/barchild=foo///bar path = foo/bar
| Parameters | |
|---|---|
pathString: String | The relative path from this reference. |
| Returns | |
|---|---|
StorageReference | the child |
getActiveDownloadTasks
fun getActiveDownloadTasks(): (Mutable)List<FileDownloadTask!>
| Returns | |
|---|---|
(Mutable)List<FileDownloadTask!> | the set of active download tasks currently in progress or recently completed. |
getActiveUploadTasks
fun getActiveUploadTasks(): (Mutable)List<UploadTask!>
| Returns | |
|---|---|
(Mutable)List<UploadTask!> | the set of active upload tasks currently in progress or recently completed. |
getBucket
fun getBucket(): String
Return the Google Cloud Storage bucket that holds this object.
| Returns | |
|---|---|
String | the bucket. |
getBytes
fun getBytes(maxDownloadSizeBytes: Long): Task<ByteArray<Byte>!>
Asynchronously downloads the object from thisStorageReference A byte array will be allocated large enough to hold the entire file in memory. Therefore, using this method will impact memory usage of your process. If you are downloading many large files,getStream may be a better option.
| Parameters | |
|---|---|
maxDownloadSizeBytes: Long | The maximum allowed size in bytes that will be allocated. Set this parameter to prevent out of memory conditions from occurring. If the download exceeds this limit, the task will fail and an |
getDownloadUrl
fun getDownloadUrl(): Task<Uri!>
Asynchronously retrieves a long lived download URL with a revokable token. This can be used to share the file with others, but can be revoked by a developer in the Firebase Console if desired.
| Returns | |
|---|---|
Task<Uri!> | The |
getFile
fun getFile(destinationFile: File): FileDownloadTask
Asynchronously downloads the object at thisStorageReference to a specified system filepath.
| Returns | |
|---|---|
FileDownloadTask | A |
getFile
fun getFile(destinationUri: Uri): FileDownloadTask
Asynchronously downloads the object at thisStorageReference to a specified system filepath.
| Parameters | |
|---|---|
destinationUri: Uri | A file system URI representing the path the object should be downloaded to. |
| Returns | |
|---|---|
FileDownloadTask | A |
getMetadata
fun getMetadata(): Task<StorageMetadata!>
Retrieves metadata associated with an object at thisStorageReference.
| Returns | |
|---|---|
Task<StorageMetadata!> | the metadata. |
getParent
fun getParent(): StorageReference?
Returns a new instance ofStorageReference pointing to the parent location or null if this instance references the root location. For example:
path=foo/bar/bazparent=foo/barpath=fooparent=(root)path=(root)parent=(null)
| Returns | |
|---|---|
StorageReference? | the parent |
getPath
fun getPath(): String
Returns the full path to this object, not including the Google Cloud Storage bucket.
| Returns | |
|---|---|
String | the path. |
getRoot
fun getRoot(): StorageReference
Returns a new instance ofStorageReference pointing to the root location.
| Returns | |
|---|---|
StorageReference | the root |
getStorage
fun getStorage(): FirebaseStorage
Returns theFirebaseStorage service which created this reference.
| Returns | |
|---|---|
FirebaseStorage | The |
getStream
fun getStream(): StreamDownloadTask
Asynchronously downloads the object at thisStorageReference via aInputStream. The InputStream should be read on anOnSuccessListener registered to run on a background thread viaaddOnSuccessListener
| Returns | |
|---|---|
StreamDownloadTask | A |
getStream
fun getStream(processor: StreamDownloadTask.StreamProcessor): StreamDownloadTask
Asynchronously downloads the object at thisStorageReference via aInputStream.
| Parameters | |
|---|---|
processor: StreamDownloadTask.StreamProcessor | A |
| Returns | |
|---|---|
StreamDownloadTask | A |
list
fun list(maxResults: Int): Task<ListResult!>
List up tomaxResults items (files) and prefixes (folders) under this StorageReference.
"/" is treated as a path delimiter. Cloud Storage for Firebase does not support object paths that end with "/" or contain two consecutive "/"s. All invalid objects in Google Cloud Storage will be filtered.
list() is only available for projects usingFirebase Rules Version 2.
| Parameters | |
|---|---|
maxResults: Int | The maximum number of results to return in a single page. Must be greater than 0 and at most 1000. |
| Returns | |
|---|---|
Task<ListResult!> | A a |
list
fun list(maxResults: Int, pageToken: String): Task<ListResult!>
Resumes a previous call tolist, starting after a pagination token. Returns the next set of items (files) and prefixes (folders) under this StorageReference.
"/" is treated as a path delimiter. Cloud Storage for Firebase does not support object paths that end with "/" or contain two consecutive "/"s. All invalid objects in Google Cloud Storage will be filtered.
list() is only available for projects usingFirebase Rules Version 2.
| Parameters | |
|---|---|
maxResults: Int | The maximum number of results to return in a single page. Must be greater than 0 and at most 1000. |
pageToken: String | A page token from a previous call to list. |
| Returns | |
|---|---|
Task<ListResult!> | A a |
listAll
fun listAll(): Task<ListResult!>
List all items (files) and prefixes (folders) under this StorageReference.
This is a helper method for callinglist() repeatedly until there are no more results. Consistency of the result is not guaranteed if objects are inserted or removed while this operation is executing.
listAll() is only available for projects usingFirebase Rules Version 2.
| Returns | |
|---|---|
Task<ListResult!> | A |
| Throws | |
|---|---|
java.lang.OutOfMemoryError: java.lang.OutOfMemoryError | If there are too many items at this location. |
putBytes
fun putBytes(bytes: ByteArray): UploadTask
Asynchronously uploads byte data to thisStorageReference. This is not recommended for large files. Instead upload a file viaputFile or anInputStream viaputStream.
| Parameters | |
|---|---|
bytes: ByteArray | The byte array to upload. |
| Returns | |
|---|---|
UploadTask | An instance of |
putBytes
fun putBytes(bytes: ByteArray, metadata: StorageMetadata): UploadTask
Asynchronously uploads byte data to thisStorageReference. This is not recommended for large files. Instead upload a file viaputFile or a Stream viaputStream.
| Parameters | |
|---|---|
bytes: ByteArray | The byte[] to upload. |
metadata: StorageMetadata |
|
| Returns | |
|---|---|
UploadTask | An instance of |
putFile
fun putFile(uri: Uri): UploadTask
Asynchronously uploads from a content URI to thisStorageReference.
| Parameters | |
|---|---|
uri: Uri | The source of the upload. This can be a file:// scheme or any content URI. A content resolver will be used to load the data. |
| Returns | |
|---|---|
UploadTask | An instance of |
putFile
fun putFile(uri: Uri, metadata: StorageMetadata): UploadTask
Asynchronously uploads from a content URI to thisStorageReference.
| Parameters | |
|---|---|
uri: Uri | The source of the upload. This can be a file:// scheme or any content URI. A content resolver will be used to load the data. |
metadata: StorageMetadata |
|
| Returns | |
|---|---|
UploadTask | An instance of |
putFile
fun putFile(uri: Uri, metadata: StorageMetadata?, existingUploadUri: Uri?): UploadTask
Asynchronously uploads from a content URI to thisStorageReference.
| Parameters | |
|---|---|
uri: Uri | The source of the upload. This can be a file:// scheme or any content URI. A content resolver will be used to load the data. |
metadata: StorageMetadata? |
|
existingUploadUri: Uri? | If set, an attempt is made to resume an existing upload session as defined by |
| Returns | |
|---|---|
UploadTask | An instance of |
putStream
fun putStream(stream: InputStream): UploadTask
Asynchronously uploads a stream of data to thisStorageReference. The stream will remain open at the end of the upload.
| Parameters | |
|---|---|
stream: InputStream | The |
| Returns | |
|---|---|
UploadTask | An instance of |
putStream
fun putStream(stream: InputStream, metadata: StorageMetadata): UploadTask
Asynchronously uploads a stream of data to thisStorageReference. The stream will remain open at the end of the upload.
| Parameters | |
|---|---|
stream: InputStream | The |
metadata: StorageMetadata |
|
| Returns | |
|---|---|
UploadTask | An instance of |
toString
fun toString(): String!
| Returns | |
|---|---|
String! | This object in URI form, which can then be shared and passed into |
updateMetadata
fun updateMetadata(metadata: StorageMetadata): Task<StorageMetadata!>
Updates the metadata associated with thisStorageReference.
| Parameters | |
|---|---|
metadata: StorageMetadata | A |
| Returns | |
|---|---|
Task<StorageMetadata!> | a |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-21 UTC.