Stay organized with collections
Save and categorize content based on your preferences.
public final class BatchResult
implements Result
The result of a batch operation. The result status is successful if and only if all results are successful. Individual results can be retrieved using BatchResultToken
objects.
Summary
Public methods
public Status
getStatus
()
Returns the status of this result. Use isSuccess
to determine whether the call was successful, and getStatusCode
to determine what the error cause was.
Certain errors are due to failures that can be resolved by launching a particular intent. The resolution intent is available via getResolution
.
public R <R extends Result
> take
( BatchResultToken
<R> resultToken)
Retrieves a result from the batch.
After the result has been retrieved, it is an error to attempt to retrieve it again. It is the responsibility of the caller to release any resources associated with the returned result. Some result types may implement Releasable
, in which case release
should be used to free the associated resources.
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\u003eBatchResult\u003c/code\u003e represents the outcome of a batch operation, succeeding only if all individual operations within the batch are successful.\u003c/p\u003e\n"],["\u003cp\u003eIndividual results from the batch operation can be accessed using \u003ccode\u003eBatchResultToken\u003c/code\u003e objects.\u003c/p\u003e\n"],["\u003cp\u003eThe overall status of the batch operation can be checked using the \u003ccode\u003egetStatus()\u003c/code\u003e method and the \u003ccode\u003estatus\u003c/code\u003e field, which provide success status and error information.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003etake()\u003c/code\u003e method is used to retrieve individual results from the batch using their corresponding \u003ccode\u003eBatchResultToken\u003c/code\u003e, and it's crucial to manage resources associated with retrieved results, especially if they implement \u003ccode\u003eReleasable\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# BatchResult\n===========\n\n[Kotlin](/android/reference/kotlin/com/google/android/gms/common/api/BatchResult \"View this page in Kotlin\") \\|Java \n\n\n```\npublic final class BatchResult implements Result\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nThe result of a batch operation. The result status is successful if and only if all results are successful. Individual results can be retrieved using [BatchResultToken](/android/reference/com/google/android/gms/common/api/BatchResultToken) objects.\n\nSummary\n-------\n\n| ### Public fields |\n|-------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|\n| `final `[Status](/android/reference/com/google/android/gms/common/api/Status) | [status](/android/reference/com/google/android/gms/common/api/BatchResult#status()) |\n\n| ### Public methods |\n|-----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Status](/android/reference/com/google/android/gms/common/api/Status) | [getStatus](/android/reference/com/google/android/gms/common/api/BatchResult#getStatus())`()` Returns the status of this result. |\n| `R` | `\u003cR extends `[Result](/android/reference/com/google/android/gms/common/api/Result)`\u003e `[take](/android/reference/com/google/android/gms/common/api/BatchResult#take(com.google.android.gms.common.api.BatchResultToken\u003cR\u003e))`(`[BatchResultToken](/android/reference/com/google/android/gms/common/api/BatchResultToken)`\u003cR\u003e resultToken)` Retrieves a result from the batch. |\n\nPublic fields\n-------------\n\n### status\n\n```\npublic final Status status\n``` \n\nPublic methods\n--------------\n\n### getStatus\n\n```\npublic Status getStatus()\n```\n\nReturns the status of this result. Use [isSuccess](/android/reference/com/google/android/gms/common/api/Status#isSuccess()) to determine whether the call was successful, and [getStatusCode](/android/reference/com/google/android/gms/common/api/Status#getStatusCode()) to determine what the error cause was.\n\nCertain errors are due to failures that can be resolved by launching a particular intent. The resolution intent is available via [getResolution](/android/reference/com/google/android/gms/common/api/Status#getResolution()). \n\n### take\n\n```\npublic R \u003cR extends Result\u003e take(BatchResultToken\u003cR\u003e resultToken)\n```\n\nRetrieves a result from the batch.\n\nAfter the result has been retrieved, it is an error to attempt to retrieve it again. It is the responsibility of the caller to release any resources associated with the returned result. Some result types may implement [Releasable](/android/reference/com/google/android/gms/common/api/Releasable), in which case [release](/android/reference/com/google/android/gms/common/api/Releasable#release()) should be used to free the associated resources."]]
