Added in API level 36
Also in T Extensions 17

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

OpenBlobForWriteResponse

Kotlin |Java

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

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

Public constructors
`OpenBlobForWriteResponse(AppSearchBatchResult<AppSearchBlobHandle, ParcelFileDescriptor> result)` Creates a `OpenBlobForWriteResponse` with given `AppSearchBatchResult`.

Public methods
`void`	`close()` Closes this stream and releases any system resources associated with it.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`AppSearchBatchResult<AppSearchBlobHandle, ParcelFileDescriptor>`	`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

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


        
          java.io.Closeable


      close()

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

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.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Fields

CREATOR

Added in API level 36
Also in T Extensions 17

public static final Creator<OpenBlobForWriteResponse> CREATOR

Public constructors

OpenBlobForWriteResponse

Added in API level 36
Also in T Extensions 17

public OpenBlobForWriteResponse (AppSearchBatchResult<AppSearchBlobHandle, ParcelFileDescriptor> result)

Creates a OpenBlobForWriteResponse with given AppSearchBatchResult.

Parameters
`result`	`AppSearchBatchResult`: This value cannot be `null`.

Public methods

close

Added in API level 36

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.

describeContents

Added in API level 36

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getResult

Added in API level 36
Also in T Extensions 17

public AppSearchBatchResult<AppSearchBlobHandle, ParcelFileDescriptor> getResult ()

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

Returns
`AppSearchBatchResult<AppSearchBlobHandle, ParcelFileDescriptor>`	A `AppSearchBatchResult` maps `AppSearchBlobHandle`s 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

Added in API level 36

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 the following: `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`