FirebaseStorage
classFirebaseStorage
FirebaseStorage is a service that supports uploading and downloading large objects to Google Cloud Storage. Pass a custom instance ofFirebaseApp togetInstance which will initialize it with a storage location (bucket) specified viasetStorageBucket.
Otherwise, if you callgetReference without a FirebaseApp, the FirebaseStorage instance will initialize with the defaultFirebaseApp obtainable fromgetInstance. The storage location in this case will come the JSON configuration file downloaded from the web.
Summary
Public functions | |
|---|---|
FirebaseApp | getApp()The |
java-staticFirebaseStorage | Returns the |
java-staticFirebaseStorage | getInstance(app: FirebaseApp)Returns the |
java-staticFirebaseStorage | getInstance(url: String)Returns the |
java-staticFirebaseStorage | getInstance(app: FirebaseApp, url: String)Returns the |
Long | Returns the maximum time to retry sending a chunk if a failure occurs |
Long | Returns the maximum time to retry a download if a failure occurs. |
Long | Returns the maximum time to retry operations other than upload and download if a failure occurs. |
Long | Returns the maximum time to retry an upload if a failure occurs. |
StorageReference | Creates a new |
StorageReference | getReference(location: String)Creates a new |
StorageReference | getReferenceFromUrl(fullUrl: String)Creates a |
Unit | setMaxChunkUploadRetry(maxChunkRetryMillis: Long)Sets the maximum time to retry sending a chunk if a failure occurs |
Unit | setMaxDownloadRetryTimeMillis(maxTransferRetryMillis: Long)Sets the maximum time to retry a download if a failure occurs. |
Unit | setMaxOperationRetryTimeMillis(maxTransferRetryMillis: Long)Sets the maximum time to retry operations other than upload and download if a failure occurs. |
Unit | setMaxUploadRetryTimeMillis(maxTransferRetryMillis: Long)Sets the maximum time to retry an upload if a failure occurs. |
Unit | useEmulator(host: String, port: Int)Modifies this FirebaseStorage instance to communicate with the Storage emulator. |
Public functions
getInstance
java-static fun getInstance(): FirebaseStorage
Returns theFirebaseStorage, initialized with the defaultFirebaseApp.
| Returns | |
|---|---|
FirebaseStorage | a |
getInstance
java-static fun getInstance(app: FirebaseApp): FirebaseStorage
Returns theFirebaseStorage, initialized with a customFirebaseApp
| Parameters | |
|---|---|
app: FirebaseApp | The custom |
| Returns | |
|---|---|
FirebaseStorage | a |
getInstance
java-static fun getInstance(url: String): FirebaseStorage
Returns theFirebaseStorage, initialized with the defaultFirebaseApp and a custom Storage Bucket.
| Parameters | |
|---|---|
url: String | The gs:// url to your Firebase Storage Bucket. |
| Returns | |
|---|---|
FirebaseStorage | a |
getInstance
java-static fun getInstance(app: FirebaseApp, url: String): FirebaseStorage
Returns theFirebaseStorage, initialized with a customFirebaseApp and a custom Storage Bucket.
| Parameters | |
|---|---|
app: FirebaseApp | The custom |
url: String | The gs:// url to your Firebase Storage Bucket. |
| Returns | |
|---|---|
FirebaseStorage | a |
getMaxChunkUploadRetry
fun getMaxChunkUploadRetry(): Long
Returns the maximum time to retry sending a chunk if a failure occurs
| Returns | |
|---|---|
Long | maximum time in milliseconds. Defaults to 1 minute. |
getMaxDownloadRetryTimeMillis
fun getMaxDownloadRetryTimeMillis(): Long
Returns the maximum time to retry a download if a failure occurs.
| Returns | |
|---|---|
Long | maximum time in milliseconds. Defaults to 10 minutes (600,000 milliseconds). |
getMaxOperationRetryTimeMillis
fun getMaxOperationRetryTimeMillis(): Long
Returns the maximum time to retry operations other than upload and download if a failure occurs.
| Returns | |
|---|---|
Long | the maximum time in milliseconds. Defaults to 2 minutes (120,000 milliseconds). |
getMaxUploadRetryTimeMillis
fun getMaxUploadRetryTimeMillis(): Long
Returns the maximum time to retry an upload if a failure occurs.
| Returns | |
|---|---|
Long | the maximum time in milliseconds. Defaults to 10 minutes (600,000 milliseconds). |
getReference
fun getReference(): StorageReference
Creates a newStorageReference initialized at the root Firebase Storage location.
| Returns | |
|---|---|
StorageReference | An instance of |
getReference
fun getReference(location: String): StorageReference
Creates a newStorageReference initialized with a child Firebase Storage location.
| Parameters | |
|---|---|
location: String | A relative path from the root to initialize the reference with, for instance "path/to/object" |
| Returns | |
|---|---|
StorageReference | An instance of |
getReferenceFromUrl
fun getReferenceFromUrl(fullUrl: String): StorageReference
Creates aStorageReference given a gs:// or https:// URL pointing to a Firebase Storage location.
| Parameters | |
|---|---|
fullUrl: String | A gs:// or http[s]:// URL used to initialize the reference. For example, you can pass in a download URL retrieved from |
setMaxChunkUploadRetry
fun setMaxChunkUploadRetry(maxChunkRetryMillis: Long): Unit
Sets the maximum time to retry sending a chunk if a failure occurs
| Parameters | |
|---|---|
maxChunkRetryMillis: Long | the maximum time in milliseconds. Defaults to 1 minute (60,000 milliseconds). |
setMaxDownloadRetryTimeMillis
fun setMaxDownloadRetryTimeMillis(maxTransferRetryMillis: Long): Unit
Sets the maximum time to retry a download if a failure occurs.
| Parameters | |
|---|---|
maxTransferRetryMillis: Long | the maximum time in milliseconds. Defaults to 10 minutes (600,000 milliseconds). |
setMaxOperationRetryTimeMillis
fun setMaxOperationRetryTimeMillis(maxTransferRetryMillis: Long): Unit
Sets the maximum time to retry operations other than upload and download if a failure occurs.
| Parameters | |
|---|---|
maxTransferRetryMillis: Long | the maximum time in milliseconds. Defaults to 2 minutes (120,000 milliseconds). |
setMaxUploadRetryTimeMillis
fun setMaxUploadRetryTimeMillis(maxTransferRetryMillis: Long): Unit
Sets the maximum time to retry an upload if a failure occurs.
| Parameters | |
|---|---|
maxTransferRetryMillis: Long | the maximum time in milliseconds. Defaults to 10 minutes (600,000 milliseconds). |
useEmulator
fun useEmulator(host: String, port: Int): Unit
Modifies this FirebaseStorage instance to communicate with the Storage emulator.
Note: Call this method before using the instance to do any storage operations.
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.