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 |
---|
Fields | |
---|---|
public
static
final
Creator<OpenBlobForWriteResponse> |
CREATOR
|
Public constructors | |
---|---|
OpenBlobForWriteResponse(AppSearchBatchResult<AppSearchBlobHandle, ParcelFileDescriptor> result)
Creates a |
Public methods | |
---|---|
void
|
close()
Closes this stream and releases any system resources associated with it. |
AppSearchBatchResult<AppSearchBlobHandle, ParcelFileDescriptor>
|
getResult()
Returns the |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
Public constructors
OpenBlobForWriteResponse
public OpenBlobForWriteResponse (AppSearchBatchResult<AppSearchBlobHandle, ParcelFileDescriptor> 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<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
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 |