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.
Nested Class Summary
| class | AppSearchBatchResult.Builder<KeyType, ValueType> | Builder for AppSearchBatchResult
objects. |
|
Public Method Summary
| Map<KeyType, AppSearchResult<ValueType>> |
getAll()
Returns a
Map of keys
mapped to instances of AppSearchResult
for all individual results.
|
| Map<KeyType, AppSearchResult<ValueType>> |
getFailures()
Returns a
Map of keys
mapped to instances of AppSearchResult
for all failed individual results.
|
| Map<KeyType, ValueType> |
getSuccesses()
Returns a
Map of keys
mapped to instances of the value type for all successful individual results.
|
| boolean |
isSuccess()
Returns
true if this
AppSearchBatchResult has no failures.
|
| String |
toString()
|
Inherited Method Summary
Public Methods
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.
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.
public Map<KeyType, ValueType> getSuccesses ()
Returns a Map of keys mapped to
instances of the value type for all successful individual results.
Example:
AppSearchClient.getByDocumentId(GetByDocumentIdRequest, String) 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.
public boolean isSuccess ()
Returns true if this AppSearchBatchResult
has no failures.