OpenBlobForWriteResponse


public final class OpenBlobForWriteResponse
extends Object implements Closeable, Parcelable

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


The response to provide batch operation results of AppSearchSession.openBlobForWrite.

This class is used to retrieve the result of a batch write operation on a collection of blob handles.

The returned ParcelFileDescriptor must be closed after use to avoid resource leaks. Failing to close the descriptor will result in system resource exhaustion, as each open ParcelFileDescriptor occupies a limited file descriptor in the system.

Summary

Inherited constants

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<OpenBlobForWriteResponse> CREATOR

Public methods

void close()

Closes this stream and releases any system resources associated with it.

AppSearchBatchResult<AppSearchBlobHandleParcelFileDescriptor> getResult()

Returns the AppSearchBatchResult object containing the results of the write blob for write operation for each AppSearchBlobHandle.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

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.

abstract void close()

Closes this stream and releases any system resources associated with it.

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.

abstract void close()

Closes this resource, relinquishing any underlying resources.

Fields

CREATOR

public static final Creator<OpenBlobForWriteResponse> CREATOR

Public constructors

OpenBlobForWriteResponse

public OpenBlobForWriteResponse (AppSearchBatchResult<AppSearchBlobHandleParcelFileDescriptor> result)

Creates a OpenBlobForWriteResponse with given AppSearchBatchResult.

Parameters
result AppSearchBatchResult: This value cannot be null.

Public methods

close

public void close ()

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable.close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

getResult

public AppSearchBatchResult<AppSearchBlobHandleParcelFileDescriptor> getResult ()

Returns the AppSearchBatchResult object containing the results of the write blob for write operation for each AppSearchBlobHandle.

Returns
AppSearchBatchResult<AppSearchBlobHandleParcelFileDescriptor> A AppSearchBatchResult maps AppSearchBlobHandles which is a unique identifier for a specific blob being committed to the outcome of that write operation. If the operation was successful, the result for that handle is ParcelFileDescriptor; if there was an error, the result contains an AppSearchResult with details of the failure. This value cannot be null.

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