StorageInfo

Kotlin |Java

class StorageInfo : Parcelable

kotlin.Any
↳	android.app.appsearch.StorageInfo

The response class of AppSearchSession#getStorageInfo.

Summary

Nested classes
	`Builder` Builder for `StorageInfo` objects.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`getAliveDocumentsCount()` Returns the number of alive documents in the current session.
Int	`getAliveNamespacesCount()` Returns the number of namespaces that have at least one alive document in the current session's database.
Int	`getBlobsCount()` Returns the total number of blobs in the session's database.
Long	`getBlobsSizeBytes()` Returns the total size of all blobs in the session's database in bytes.
Long	`getSizeBytes()` Returns the estimated size of the session's database in bytes.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<StorageInfo!>	`CREATOR`

Public methods

getAliveDocumentsCount

Added in API level 31

fun getAliveDocumentsCount(): Int

Returns the number of alive documents in the current session.

Alive documents are documents that haven't been deleted and haven't exceeded the ttl as set in GenericDocument.Builder.setTtlMillis.

getAliveNamespacesCount

Added in API level 31

fun getAliveNamespacesCount(): Int

Returns the number of namespaces that have at least one alive document in the current session's database.

Alive documents are documents that haven't been deleted and haven't exceeded the ttl as set in GenericDocument.Builder.setTtlMillis.

getBlobsCount

Added in API level Baklava

fun getBlobsCount(): Int

Returns the total number of blobs in the session's database.

Blobs are binary large objects associated with the documents in the database. Pending blobs that haven't been committed and orphan blobs that haven't been cleared will be counted with alive blobs as well.

getBlobsSizeBytes

Added in API level Baklava

fun getBlobsSizeBytes(): Long

Returns the total size of all blobs in the session's database in bytes.

getSizeBytes

Added in API level 31

fun getSizeBytes(): Long

Returns the estimated size of the session's database in bytes.

writeToParcel

Added in API level 35

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 35
Also in T Extensions 13

static val CREATOR: Parcelable.Creator<StorageInfo!>