StorageInfo


class StorageInfo


The response class of AppSearchSession#getStorageInfo.

Summary

Nested types

Builder for StorageInfo objects.

Public functions

Int

Returns the number of alive documents in the current session.

Int

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

Int

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

Long

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

Long

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

Public functions

getAliveDocumentsCount

Added in 1.1.0-beta01
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 setTtlMillis.

getAliveNamespacesCount

Added in 1.1.0-beta01
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 setTtlMillis.

getBlobsCount

Added in 1.1.0-beta01
@ExperimentalAppSearchApi
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 1.1.0-beta01
@ExperimentalAppSearchApi
fun getBlobsSizeBytes(): Long

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.

getSizeBytes

Added in 1.1.0-beta01
fun getSizeBytes(): Long

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