Added in API level 31

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

StorageInfo

---

Kotlin |Java

public final class StorageInfo
extends Object implements Parcelable

java.lang.Object
↳	android.app.appsearch.StorageInfo

---

The response class of AppSearchSession#getStorageInfo.

Summary

Nested classes
class	StorageInfo.Builder Builder for StorageInfo objects.

Inherited constants

From interface android.os.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(Parcel, int): 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)".

Fields
public static final Creator<StorageInfo>	CREATOR

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.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 35
Also in T Extensions 13

public static final Creator<StorageInfo> CREATOR

Public methods

getAliveDocumentsCount

Added in API level 31

public int getAliveDocumentsCount ()

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.

Returns
int

getAliveNamespacesCount

Added in API level 31

public int getAliveNamespacesCount ()

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.

Returns
int

getBlobsCount

Added in Android Baklava

public int getBlobsCount ()

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.

Returns
int

getBlobsSizeBytes

Added in Android Baklava

public long getBlobsSizeBytes ()

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

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 along with alive blobs.

Returns
long

getSizeBytes

Added in API level 31

public long getSizeBytes ()

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

Returns
long

writeToParcel

Added in API level 35

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES