AppSearchBatchResult
public
final
class
AppSearchBatchResult
extends Object
java.lang.Object | |
↳ | android.app.appsearch.AppSearchBatchResult<KeyType, ValueType> |
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.
See also:
Summary
Nested classes | |
---|---|
class |
AppSearchBatchResult.Builder<KeyType, ValueType>
Builder for |
Public methods | |
---|---|
Map<KeyType, AppSearchResult<ValueType>>
|
getAll()
Returns a |
Map<KeyType, AppSearchResult<ValueType>>
|
getFailures()
Returns a |
Map<KeyType, ValueType>
|
getSuccesses()
Returns a |
boolean
|
isSuccess()
Returns |
String
|
toString()
Returns a string representation of the object. |
Inherited methods | |
---|---|
Public methods
getAll
public Map<KeyType, AppSearchResult<ValueType>> getAll ()
Returns a Map
of keys mapped to instances of AppSearchResult
for all
individual results.
The values of the Map
will not be null
.
Returns | |
---|---|
Map<KeyType, AppSearchResult<ValueType>> |
getFailures
public Map<KeyType, AppSearchResult<ValueType>> getFailures ()
Returns a Map
of keys mapped to instances of AppSearchResult
for all failed
individual results.
The values of the Map
will not be null
.
Returns | |
---|---|
Map<KeyType, AppSearchResult<ValueType>> |
getSuccesses
public Map<KeyType, ValueType> getSuccesses ()
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
.
Returns | |
---|---|
Map<KeyType, ValueType> |
isSuccess
public boolean isSuccess ()
Returns true
if this AppSearchBatchResult
has no failures.
Returns | |
---|---|
boolean |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
This value cannot be null . |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-04 UTC.