StorageInfo

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

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.

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

Fields

CREATOR

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

getSizeBytes

Added in API level 31
public long getSizeBytes ()

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

Returns
long

writeToParcel

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