firebase-storage/com.google.firebase.storage/StorageMetadata

StorageMetadata

The metadata of an object in Cloud Storage, as the Android SDK's StorageMetadata: the server-set fields are read from a fetched object, the settable fields are built with Builder (chained setters or, from Kotlin, properties: storageMetadata { contentType = "text/plain" }).

expect class StorageMetadata(source)

actual class StorageMetadata(source)

Constructors

StorageMetadata

actual constructor()

expect constructor()

actual constructor()

Types

Builder

actual class Builder

Builds the settable metadata, from scratch or from an existing StorageMetadata.

expect class Builder

Builds the settable metadata, from scratch or from an existing StorageMetadata.

actual class Builder

Builds the settable metadata, from scratch or from an existing StorageMetadata.

Properties

bucket

actual val bucket: String?

The bucket, once fetched.

expect val bucket: String?

The bucket, once fetched.

actual val bucket: String?

The bucket, once fetched.

cacheControl

actual val cacheControl: String?

The Cache-Control header.

expect val cacheControl: String?

The Cache-Control header.

actual val cacheControl: String?

The Cache-Control header.

contentDisposition

actual val contentDisposition: String?

The Content-Disposition header.

expect val contentDisposition: String?

The Content-Disposition header.

actual val contentDisposition: String?

The Content-Disposition header.

contentEncoding

actual val contentEncoding: String?

The Content-Encoding header.

expect val contentEncoding: String?

The Content-Encoding header.

actual val contentEncoding: String?

The Content-Encoding header.

contentLanguage

actual val contentLanguage: String?

The Content-Language header.

expect val contentLanguage: String?

The Content-Language header.

actual val contentLanguage: String?

The Content-Language header.

contentType

actual val contentType: String?

The Content-Type header.

expect val contentType: String?

The Content-Type header.

actual val contentType: String?

The Content-Type header.

creationTimeMillis

actual val creationTimeMillis: Long

When the object was created, in milliseconds since the epoch; 0 until fetched.

expect val creationTimeMillis: Long

When the object was created, in milliseconds since the epoch; 0 until fetched.

actual val creationTimeMillis: Long

When the object was created, in milliseconds since the epoch; 0 until fetched.

customMetadataKeys

actual val customMetadataKeys: Set<String>

The keys of the custom metadata.

expect val customMetadataKeys: Set<String>

The keys of the custom metadata.

actual val customMetadataKeys: Set<String>

The keys of the custom metadata.

generation

actual val generation: String?

The object's generation, once fetched.

expect val generation: String?

The object's generation, once fetched.

actual val generation: String?

The object's generation, once fetched.

md5Hash

actual val md5Hash: String?

The MD5 hash of the content, once fetched.

expect val md5Hash: String?

The MD5 hash of the content, once fetched.

actual val md5Hash: String?

The MD5 hash of the content, once fetched.

metadataGeneration

actual val metadataGeneration: String?

The metadata's generation, once fetched.

expect val metadataGeneration: String?

The metadata's generation, once fetched.

actual val metadataGeneration: String?

The metadata's generation, once fetched.

name

actual val name: String?

The object's name (the last path segment), once fetched.

expect val name: String?

The object's name (the last path segment), once fetched.

actual val name: String?

The object's name (the last path segment), once fetched.

path

actual val path: String

The object's full path; empty until fetched.

expect val path: String

The object's full path; empty until fetched.

actual val path: String

The object's full path; empty until fetched.

reference

actual val reference: StorageReference?

The reference of the object, once fetched.

expect val reference: StorageReference?

The reference of the object, once fetched.

actual val reference: StorageReference?

The reference of the object, once fetched.

sizeBytes

actual val sizeBytes: Long

The size in bytes; 0 until fetched.

expect val sizeBytes: Long

The size in bytes; 0 until fetched.

actual val sizeBytes: Long

The size in bytes; 0 until fetched.

updatedTimeMillis

actual val updatedTimeMillis: Long

When the object was last updated, in milliseconds since the epoch; 0 until fetched.

expect val updatedTimeMillis: Long

When the object was last updated, in milliseconds since the epoch; 0 until fetched.

actual val updatedTimeMillis: Long

When the object was last updated, in milliseconds since the epoch; 0 until fetched.

Functions

getCustomMetadata

actual fun getCustomMetadata(key: String): String?

The custom metadata value of key, or null if it is not set.

expect fun getCustomMetadata(key: String): String?

The custom metadata value of key, or null if it is not set.

actual fun getCustomMetadata(key: String): String?

The custom metadata value of key, or null if it is not set.

toString

open override fun toString(): String