Stay organized with collections
Save and categorize content based on your preferences.
public final class Batch.Builder
Builder for Batch
objects. Note that this class is not thread-safe, by design.
Summary
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 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eBatch.Builder\u003c/code\u003e is used to create \u003ccode\u003eBatch\u003c/code\u003e objects for managing multiple pending operations in Google APIs.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to add \u003ccode\u003ePendingResult\u003c/code\u003e objects to the batch and build the final \u003ccode\u003eBatch\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eBatchResultToken\u003c/code\u003e is used to retrieve individual results from the completed \u003ccode\u003eBatchResult\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThis class is designed to be used in a non-thread-safe manner.\u003c/p\u003e\n"]]],["The `Batch.Builder` class constructs `Batch` objects, designed for non-thread-safe operations. To create a `Batch`, initialize a `Builder` with a `GoogleApiClient`. Use the `add` method to incorporate `PendingResult` items, obtaining a `BatchResultToken` for result retrieval. Finally, call `build` to finalize and create the `Batch` object containing all the pending operations.\n"],null,["# Batch.Builder\n=============\n\n[Kotlin](/android/reference/kotlin/com/google/android/gms/common/api/Batch.Builder \"View this page in Kotlin\") \\|Java \n\n\n```\npublic final class Batch.Builder\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nBuilder for [Batch](/android/reference/com/google/android/gms/common/api/Batch) objects. Note that this class is not thread-safe, by design.\n\nSummary\n-------\n\n| ### Public constructors |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Builder](/android/reference/com/google/android/gms/common/api/Batch.Builder#Builder(com.google.android.gms.common.api.GoogleApiClient))`(`[GoogleApiClient](/android/reference/com/google/android/gms/common/api/GoogleApiClient)` googleApiClient)` |\n\n| ### Public methods |\n|------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [BatchResultToken](/android/reference/com/google/android/gms/common/api/BatchResultToken)`\u003cR\u003e` | `\u003cR extends `[Result](/android/reference/com/google/android/gms/common/api/Result)`\u003e `[add](/android/reference/com/google/android/gms/common/api/Batch.Builder#add(com.google.android.gms.common.api.PendingResult\u003cR\u003e))`(`[PendingResult](/android/reference/com/google/android/gms/common/api/PendingResult)`\u003cR\u003e pendingResult)` Adds a [PendingResult](/android/reference/com/google/android/gms/common/api/PendingResult) to the batch. |\n| [Batch](/android/reference/com/google/android/gms/common/api/Batch) | [build](/android/reference/com/google/android/gms/common/api/Batch.Builder#build())`()` |\n\nPublic constructors\n-------------------\n\n### Builder\n\n```\npublic Builder(GoogleApiClient googleApiClient)\n``` \n\nPublic methods\n--------------\n\n### add\n\n```\npublic BatchResultToken\u003cR\u003e \u003cR extends Result\u003e add(PendingResult\u003cR\u003e pendingResult)\n```\n\nAdds a [PendingResult](/android/reference/com/google/android/gms/common/api/PendingResult) to the batch. The returned token can be used to retrieve the result from the [BatchResult](/android/reference/com/google/android/gms/common/api/BatchResult) passed to the result callback. \n\n| Parameters |\n|--------------------------------------------------------------------------------------------------------|----------------------------------|\n| [PendingResult](/android/reference/com/google/android/gms/common/api/PendingResult)`\u003cR\u003e pendingResult` | Items to wait for completion of. |\n\n| Returns |\n|------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|\n| [BatchResultToken](/android/reference/com/google/android/gms/common/api/BatchResultToken)`\u003cR\u003e` | The result token to use to get the result from the [BatchResult](/android/reference/com/google/android/gms/common/api/BatchResult). |\n\n### build\n\n```\npublic Batch build()\n```"]]
