CommitBlobResponse


public final class CommitBlobResponse
extends Object implements Parcelable

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


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

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

Summary

Inherited constants

Fields

public static final Creator<CommitBlobResponse> CREATOR

Public constructors

CommitBlobResponse(AppSearchBatchResult<AppSearchBlobHandleVoid> result)

Creates a CommitBlobResponse with given AppSearchBatchResult.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

AppSearchBatchResult<AppSearchBlobHandleVoid> getResult()

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

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 36
Also in T Extensions 17
public static final Creator<CommitBlobResponse> CREATOR

Public constructors

CommitBlobResponse

Added in API level 36
Also in T Extensions 17
public CommitBlobResponse (AppSearchBatchResult<AppSearchBlobHandleVoid> result)

Creates a CommitBlobResponse with given AppSearchBatchResult.

Parameters
result AppSearchBatchResult: This value cannot be null.

Public methods

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

getResult

Added in API level 36
Also in T Extensions 17
public AppSearchBatchResult<AppSearchBlobHandleVoid> getResult ()

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

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

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: