Summary: Inherited Constants | Fields | Methods | Inherited Methods

AppSearchBlobHandle

Kotlin |Java

public final class AppSearchBlobHandle
extends Object implements Parcelable

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

An identifier to represent a blob in AppSearch.

A "blob" is a large binary object. It is used to store a significant amount of data that is not searchable, such as images, videos, audio files, or other binary data. Unlike other fields in AppSearch, blobs are stored as blob files on disk rather than in memory, and use ParcelFileDescriptor to read and write. This allows for efficient handling of large, non-searchable content.

AppSearchBlobHandle is a light-weight Property of GenericDocument, which is a pointer to the heavy-weight blob data.

The blob data could be written via AppSearchSession.openBlobForWrite and read via AppSearchSession.openBlobForRead.

A GenericDocument with AppSearchBlobHandle Property could be put and read without the large blob data. This offers lazy retrieval to blob data when searching GenericDocument in AppSearch.

See also:

GenericDocument.Builder.setPropertyBlobHandle(String, AppSearchBlobHandle)

Summary

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<AppSearchBlobHandle>`	`CREATOR`

Public methods
`static AppSearchBlobHandle`	`createWithSha256(byte[] digest, String packageName, String databaseName, String namespace)` Create a new AppSearch blob identifier with given digest, package, database and namespace.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`String`	`getDatabaseName()` Returns the name of database stored the blob that this object is representing.
`String`	`getNamespace()` Returns the app-defined namespace this blob resides in.
`String`	`getPackageName()` Returns the package name indicating the owner app of the blob that this object is representing.
`byte[]`	`getSha256Digest()` Returns the SHA-256 hash of the blob that this object is representing.
`int`	`hashCode()` Returns a hash code value for the object.
`String`	`toString()` Returns a string representation of the object.
`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 Android Baklava

public static final Creator<AppSearchBlobHandle> CREATOR

Public methods

createWithSha256

Added in Android Baklava

public static AppSearchBlobHandle createWithSha256 (byte[] digest, 
                String packageName, 
                String databaseName, 
                String namespace)

Create a new AppSearch blob identifier with given digest, package, database and namespace.

The package name and database name indicated where this blob will be stored. To write, commit or read this blob via AppSearchSession, it must match the package name and database name of AppSearchSession.

For two objects of AppSearchBlobHandle to be considered equal, the packageName, database, namespace and digest must be equal.

Parameters
`digest`	`byte`: The SHA-256 hash of the blob this is representing. This value cannot be `null`.
`packageName`	`String`: The package name of the owner of this Blob. This value cannot be `null`.
`databaseName`	`String`: The database name of this blob to stored into. This value cannot be `null`.
`namespace`	`String`: The namespace of this blob resides in. This value cannot be `null`.

Returns
`AppSearchBlobHandle`	a new instance of `AppSearchBlobHandle` object. This value cannot be `null`.

equals

Added in Android Baklava

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`o`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getDatabaseName

Added in Android Baklava

public String getDatabaseName ()

Returns the name of database stored the blob that this object is representing.

For two objects of AppSearchBlobHandle to be considered equal, the packageName, database, namespace and digest must be equal.

Returns
`String`	This value cannot be `null`.

getNamespace

Added in Android Baklava

public String getNamespace ()

Returns the app-defined namespace this blob resides in.

For two objects of AppSearchBlobHandle to be considered equal, the packageName, database, namespace and digest must be equal.

Returns
`String`	This value cannot be `null`.

getPackageName

Added in Android Baklava

public String getPackageName ()

Returns the package name indicating the owner app of the blob that this object is representing.

For two objects of AppSearchBlobHandle to be considered equal, the packageName, database, namespace and digest must be equal.

Returns
`String`	This value cannot be `null`.

getSha256Digest

Added in Android Baklava

public byte[] getSha256Digest ()

Returns the SHA-256 hash of the blob that this object is representing.

For two objects of AppSearchBlobHandle to be considered equal, the packageName, database, namespace and digest must be equal.

Returns
`byte[]`	This value cannot be `null`.

hashCode

Added in Android Baklava

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
`int`	a hash code value for this object.

toString

Added in Android Baklava

public String toString ()

Returns a string representation of the object.

Returns
`String`	This value cannot be `null`.

writeToParcel

Added in Android Baklava

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