Represents a reference to a Google Cloud Storage object. Developers canupload, download, and delete objects, as well as get/set object metadata.

Index

Properties

bucket

bucket:string

The name of the bucket containing this reference's object.

fullPath

fullPath:string

The full path of this object.

name

name:string

The short name of this object, which is the last component of the full path.For example, if fullPath is 'full/path/image.png', name is 'image.png'.

parent

parent:Reference |null

A reference pointing to the parent location of this reference, or null ifthis reference is the root.

root

A reference to the root of this reference's bucket.

storage

storage:Storage

The storage service associated with this reference.

Methods

child

  • child(path: string):Reference

  • Returns a reference to a relative path from this reference.

    Parameters

    • path:string

      The relative path from this reference.Leading, trailing, and consecutive slashes are removed.

    ReturnsReference

    The reference to the given path.

delete

  • delete():Promise<void>

  • Deletes the object at this reference's location.

    ReturnsPromise<void>

    A Promise that resolves if the deletionsucceeded and rejects if it failed, including if the object didn't exist.

getDownloadURL

  • getDownloadURL():Promise<string>

  • Fetches a long lived download URL for this object.

    ReturnsPromise<string>

    A Promise that resolves with the downloadURL or rejects if the fetch failed, including if the object did notexist.

getMetadata

  • getMetadata():Promise<FullMetadata>

  • Fetches metadata for the object at this location, if one exists.

    ReturnsPromise<FullMetadata>

    A Promise thatresolves with the metadata, or rejects if the fetch failed, including ifthe object did not exist.

list

  • list(options?: ListOptions):Promise<ListResult>

  • List items (files) and prefixes (folders) under this storage reference.

    List API is only available for Firebase Rules Version 2.

    GCS is a key-blob store. Firebase Storage imposes the semantic of '/'delimited folder structure.Refer to GCS's List API if you want to learn more.

    To adhere to Firebase Rules's Semantics, Firebase Storage does notsupport objects whose paths end with "/" or contain two consecutive"/"s. Firebase Storage List API will filter these unsupported objects.list() may fail if there are too many unsupported objects in the bucket.

    Parameters

    • Optional options:ListOptions

      SeeListOptions for details.

    ReturnsPromise<ListResult>

    A Promise that resolves with the items and prefixes.prefixes contains references to sub-folders anditemscontains references to objects in this folder.nextPageTokencan be used to get the rest of the results.

listAll

  • listAll():Promise<ListResult>

  • List all items (files) and prefixes (folders) under this storage reference.

    This is a helper method for callinglist() repeatedly until there areno more results. The default pagination size is 1000.

    Note: The results may not be consistent if objects are changed while thisoperation is running.

    Warning:listAll may potentially consume too many resources if there aretoo many results.

    ReturnsPromise<ListResult>

    A Promise that resolves with all the items and prefixes underthe current storage reference.prefixes contains references tosub-directories anditems contains references to objects in thisfolder.nextPageToken is never returned.

put

  • put(data: Blob |Uint8Array |ArrayBuffer, metadata?: UploadMetadata):UploadTask

  • Uploads data to this reference's location.

    Parameters

    • data:Blob |Uint8Array |ArrayBuffer

      The data to upload.

    • Optional metadata:UploadMetadata

      Metadata for the newlyuploaded object.

    ReturnsUploadTask

    An object that can be used to monitorand manage the upload.

putString

  • putString(data: string, format?: StringFormat, metadata?: UploadMetadata):UploadTask

  • Uploads string data to this reference's location.

    throws

    If the format is not an allowed format, or if the given stringdoesn't conform to the specified format.

    Parameters

    • data:string

      The string to upload.

    • Optional format:StringFormat

      The format of the string toupload.

    • Optional metadata:UploadMetadata

      Metadata for the newlyuploaded object.

    ReturnsUploadTask

toString

  • toString():string

  • Returns a gs:// URL for this object in the formgs://<bucket>/<path>/<to>/<object>

    Returnsstring

    The gs:// URL.

updateMetadata

  • updateMetadata(metadata: SettableMetadata):Promise<FullMetadata>

  • Updates the metadata for the object at this location, if one exists.

    Parameters

    • metadata:SettableMetadata

      The new metadata.Setting a property to 'null' removes it on the server, while leavinga property as 'undefined' has no effect.

    ReturnsPromise<FullMetadata>

    A Promise thatresolves with the full updated metadata or rejects if the updated failed,including if the object did not exist.

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 2023-09-28 UTC.