AppSearchBatchResult.Builder

public static final class AppSearchBatchResult.Builder
extends Object

java.lang.Object
   ↳ android.app.appsearch.AppSearchBatchResult.Builder<KeyType, ValueType>


Builder for AppSearchBatchResult objects.

Summary

Public constructors

Builder()

Public methods

AppSearchBatchResult<KeyType, ValueType> build()

Builds an AppSearchBatchResult object from the contents of this Builder.

Builder<KeyType, ValueType> setFailure(KeyType key, int resultCode, String errorMessage)

Associates the key with the provided failure code and error message.

Builder<KeyType, ValueType> setResult(KeyType key, AppSearchResult<ValueType> result)

Associates the key with the provided result.

Builder<KeyType, ValueType> setSuccess(KeyType key, ValueType value)

Associates the key with the provided successful return value.

Inherited methods

Public constructors

Builder

Added in API level 31
public Builder ()

Public methods

build

Added in API level 31
public AppSearchBatchResult<KeyType, ValueType> build ()

Builds an AppSearchBatchResult object from the contents of this Builder.

Returns
AppSearchBatchResult<KeyType, ValueType> This value cannot be null.

setFailure

Added in API level 31
public Builder<KeyType, ValueType> setFailure (KeyType key, 
                int resultCode, 
                String errorMessage)

Associates the key with the provided failure code and error message.

Any previous mapping for a key, whether success or failure, is deleted.

This is a convenience function which is equivalent to setResult(key, AppSearchResult.newFailedResult(resultCode, errorMessage)).

Parameters
key KeyType: The key to associate the result with; usually corresponds to some identifier from the input like an ID or name. This value cannot be null.

resultCode int: One of the constants documented in AppSearchResult.getResultCode(). Value is AppSearchResult.RESULT_OK, AppSearchResult.RESULT_UNKNOWN_ERROR, AppSearchResult.RESULT_INTERNAL_ERROR, AppSearchResult.RESULT_INVALID_ARGUMENT, AppSearchResult.RESULT_IO_ERROR, AppSearchResult.RESULT_OUT_OF_SPACE, AppSearchResult.RESULT_NOT_FOUND, AppSearchResult.RESULT_INVALID_SCHEMA, AppSearchResult.RESULT_SECURITY_ERROR, android.app.appsearch.AppSearchResult.RESULT_DENIED, or android.app.appsearch.AppSearchResult.RESULT_RATE_LIMITED

errorMessage String: An optional string describing the reason or nature of the failure. This value may be null.

Returns
Builder<KeyType, ValueType> This value cannot be null.

setResult

Added in API level 31
public Builder<KeyType, ValueType> setResult (KeyType key, 
                AppSearchResult<ValueType> result)

Associates the key with the provided result.

Any previous mapping for a key, whether success or failure, is deleted.

Parameters
key KeyType: The key to associate the result with; usually corresponds to some identifier from the input like an ID or name. This value cannot be null.

result AppSearchResult: The result to associate with the key. This value cannot be null.

Returns
Builder<KeyType, ValueType> This value cannot be null.

setSuccess

Added in API level 31
public Builder<KeyType, ValueType> setSuccess (KeyType key, 
                ValueType value)

Associates the key with the provided successful return value.

Any previous mapping for a key, whether success or failure, is deleted.

This is a convenience function which is equivalent to setResult(key, AppSearchResult.newSuccessfulResult(value)).

Parameters
key KeyType: The key to associate the result with; usually corresponds to some identifier from the input like an ID or name. This value cannot be null.

value ValueType: An optional value to associate with the successful result of the operation being performed. This value may be null.

Returns
Builder<KeyType, ValueType> This value cannot be null.