AppSearchBatchResult
class AppSearchBatchResult<KeyType : Any!, ValueType : Any!>
| kotlin.Any | |
| ↳ | android.app.appsearch.AppSearchBatchResult |
Provides results for AppSearch batch operations which encompass multiple documents.
Individual results of a batch operation are separated into two maps: one for successes and one for failures. For successes, getSuccesses() will return a map of keys to instances of the value type. For failures, getFailures() will return a map of keys to AppSearchResult objects.
Alternatively, getAll() returns a map of keys to AppSearchResult objects for both successes and failures.
Summary
| Nested classes | |
|---|---|
|
Builder for |
|
| Public methods | |
|---|---|
| MutableMap<KeyType, AppSearchResult<ValueType>!> |
getAll()Returns a |
| MutableMap<KeyType, AppSearchResult<ValueType>!> |
Returns a |
| MutableMap<KeyType, ValueType> |
Returns a |
| Boolean |
Returns |
| String |
toString()Returns a string representation of the object. |
Public methods
getAll
fun getAll(): MutableMap<KeyType, AppSearchResult<ValueType>!>
Returns a Map of keys mapped to instances of AppSearchResult for all individual results.
The values of the Map will not be null.
getFailures
fun getFailures(): MutableMap<KeyType, AppSearchResult<ValueType>!>
Returns a Map of keys mapped to instances of AppSearchResult for all failed individual results.
The values of the Map will not be null.
getSuccesses
fun getSuccesses(): MutableMap<KeyType, ValueType>
Returns a Map of keys mapped to instances of the value type for all successful individual results.
Example: AppSearchSession#getByDocumentId returns an AppSearchBatchResult. Each key (the document ID, of String type) will map to a GenericDocument object.
The values of the Map will not be null.
isSuccess
fun isSuccess(): Boolean
Returns true if this AppSearchBatchResult has no failures.
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
This value cannot be null. |