FirebaseStorage

public class FirebaseStorage extends Object

FirebaseStorage is a service that supports uploading and downloading large objects to Google Cloud Storage. Pass a custom instance of FirebaseApp to getInstance(FirebaseApp) which will initialize it with a storage location (bucket) specified via setStorageBucket(String).

Otherwise, if you call getReference() without a FirebaseApp, the FirebaseStorage instance will initialize with the default FirebaseApp obtainable from getInstance(). The storage location in this case will come the JSON configuration file downloaded from the web.

Public Method Summary

FirebaseApp
getApp()
The FirebaseApp associated with this FirebaseStorage instance.
static FirebaseStorage
getInstance(String url)
Returns the FirebaseStorage, initialized with the default FirebaseApp and a custom Storage Bucket.
static FirebaseStorage
getInstance()
Returns the FirebaseStorage, initialized with the default FirebaseApp.
static FirebaseStorage
getInstance(FirebaseApp app)
Returns the FirebaseStorage, initialized with a custom FirebaseApp
static FirebaseStorage
getInstance(FirebaseApp app, String url)
Returns the FirebaseStorage, initialized with a custom FirebaseApp and a custom Storage Bucket.
long
getMaxDownloadRetryTimeMillis()
Returns the maximum time to retry a download if a failure occurs.
long
getMaxOperationRetryTimeMillis()
Returns the maximum time to retry operations other than upload and download if a failure occurs.
long
getMaxUploadRetryTimeMillis()
Returns the maximum time to retry an upload if a failure occurs.
StorageReference
getReference()
Creates a new StorageReference initialized at the root Firebase Storage location.
StorageReference
getReference(String location)
Creates a new StorageReference initialized with a child Firebase Storage location.
StorageReference
getReferenceFromUrl(String fullUrl)
Creates a StorageReference given a gs:// or // URL pointing to a Firebase Storage location.
void
setMaxDownloadRetryTimeMillis(long maxTransferRetryMillis)
Sets the maximum time to retry a download if a failure occurs.
void
setMaxOperationRetryTimeMillis(long maxTransferRetryMillis)
Sets the maximum time to retry operations other than upload and download if a failure occurs.
void
setMaxUploadRetryTimeMillis(long maxTransferRetryMillis)
Sets the maximum time to retry an upload if a failure occurs.

Inherited Method Summary

Public Methods

public FirebaseApp getApp ()

The FirebaseApp associated with this FirebaseStorage instance.

public static FirebaseStorage getInstance (String url)

Returns the FirebaseStorage, initialized with the default FirebaseApp and a custom Storage Bucket.

Parameters
url The gs:// url to your Firebase Storage Bucket.
Returns

public static FirebaseStorage getInstance ()

Returns the FirebaseStorage, initialized with the default FirebaseApp.

Returns

public static FirebaseStorage getInstance (FirebaseApp app)

Returns the FirebaseStorage, initialized with a custom FirebaseApp

Parameters
app The custom FirebaseApp used for initialization.
Returns

public static FirebaseStorage getInstance (FirebaseApp app, String url)

Returns the FirebaseStorage, initialized with a custom FirebaseApp and a custom Storage Bucket.

Parameters
app The custom FirebaseApp used for initialization.
url The gs:// url to your Firebase Storage Bucket.
Returns

public long getMaxDownloadRetryTimeMillis ()

Returns the maximum time to retry a download if a failure occurs.

Returns
  • maximum time in milliseconds. Defaults to 10 minutes (600,000 milliseconds).

public long getMaxOperationRetryTimeMillis ()

Returns the maximum time to retry operations other than upload and download if a failure occurs.

Returns
  • the maximum time in milliseconds. Defaults to 2 minutes (120,000 milliseconds).

public long getMaxUploadRetryTimeMillis ()

Returns the maximum time to retry an upload if a failure occurs.

Returns
  • the maximum time in milliseconds. Defaults to 10 minutes (600,000 milliseconds).

public StorageReference getReference ()

Creates a new StorageReference initialized at the root Firebase Storage location.

Returns

public StorageReference getReference (String location)

Creates a new StorageReference initialized with a child Firebase Storage location.

Parameters
location A relative path from the root to initialize the reference with, for instance "path/to/object"
Returns

public StorageReference getReferenceFromUrl (String fullUrl)

Creates a StorageReference given a gs:// or // URL pointing to a Firebase Storage location.

Parameters
fullUrl A gs:// or http[s]:// URL used to initialize the reference. For example, you can pass in a download URL retrieved from getDownloadUrl() or the uri retrieved from toString() An error is thrown if fullUrl is not associated with the FirebaseApp used to initialize this FirebaseStorage.

public void setMaxDownloadRetryTimeMillis (long maxTransferRetryMillis)

Sets the maximum time to retry a download if a failure occurs.

Parameters
maxTransferRetryMillis the maximum time in milliseconds. Defaults to 10 minutes (600,000 milliseconds).

public void setMaxOperationRetryTimeMillis (long maxTransferRetryMillis)

Sets the maximum time to retry operations other than upload and download if a failure occurs.

Parameters
maxTransferRetryMillis the maximum time in milliseconds. Defaults to 2 minutes (120,000 milliseconds).

public void setMaxUploadRetryTimeMillis (long maxTransferRetryMillis)

Sets the maximum time to retry an upload if a failure occurs.

Parameters
maxTransferRetryMillis the maximum time in milliseconds. Defaults to 10 minutes (600,000 milliseconds).

Send feedback about...

Need help? Visit our support page.