Stay organized with collections
Save and categorize content based on your preferences.
public final class Batch extends PendingResult
Handles a batch of PendingResult items. Callbacks can be added and you can block to wait for all items in the batch to complete like any other PendingResult item. A Batch can also be canceled if the results are no longer needed. In this case, the onBatchComplete callback will never be triggered.
The results can be taken either from the underlying PendingResults or via take but not both.
Summary
Nested types |
|
Builder for Batch objects.
|
Public methods |
void |
Requests that the batch be canceled.
|
Inherited methods |
From com.google.android.gms.common.api.PendingResult
abstract @NonNull R |
Blocks until the task is completed or has timed out waiting for the result.
|
abstract void |
Set the callback here if you want the result to be delivered via a callback when the result is ready.
|
abstract void |
Set the callback here if you want the result to be delivered via a callback when the result is ready or has timed out waiting for the result.
|
@NonNull TransformedResult<S> |
Transforms the result by making another API call.
|
|
Public methods
public void cancel()
Requests that the batch be canceled. Cancels all underlying PendingResults.
onResult will never be called, await will return a failed result with status CANCELED.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-08-19 UTC.
[null,null,["Last updated 2026-08-19 UTC."],[],["`Batch` handles multiple `PendingResult` items, allowing you to add callbacks and wait for completion. You can use `await()` to block until the task is finished or timed out, or add a callback with `setResultCallback()` to be notified when the result is ready. The `cancel()` method allows you to cancel the batch, which prevents the `onResult` callback from firing. Results can also be taken from the underlying `PendingResults`s. `isCanceled` checks if the `PendingResult` has been canceled.\n"]]