AdsApp.MutateResult
Stay organized with collections
Save and categorize content based on your preferences.
The result of a Mutate operation. Either error or resourceName will be
specified if the operation failed or succeeded respectively.
Methods:
| Member | Type | Description |
|---|
| getErrorMessages() |
String[] |
If the operation failed, this will return the error messages. |
| getResourceName() |
String |
If the operation succeeded, this will return the resource name of the
affected entity. |
| isSuccessful() |
boolean |
Returns true if the associated mutate completed successfully,
or false if it failed. |
getErrorMessages()
If the operation failed, this will return the error messages. If the
operation succeeded, this will return an empty array.
Return values:
| Type | Description |
|---|
String[] |
The error messages if the operation failed, or an empty array if it
succeeded. |
getResourceName()
If the operation succeeded, this will return the resource name of the
affected entity. For update and remove operations, this will match the
resourceName specified in the Mutate. For create operations, this will
return the resourceName for the newly created entity.
If the operation failed, this wil return null.
Return values:
| Type | Description |
|---|
String |
The mutated entity's resource name if the operation succeeded, or
null if it failed. |
isSuccessful()
Returns
true if the associated mutate completed successfully,
or
false if it failed.
Return values:
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 2025-08-25 UTC.
[null,null,["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThis documentation describes the \u003ccode\u003eMutateOperation.Result\u003c/code\u003e object, which indicates the outcome of a Mutate operation.\u003c/p\u003e\n"],["\u003cp\u003eThe result provides information about success or failure, including error messages if applicable.\u003c/p\u003e\n"],["\u003cp\u003eAccess methods are available to retrieve error messages, the resource name of the affected entity, and overall operation status.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetResourceName()\u003c/code\u003e returns the name of the affected entity on success, useful for identifying created or modified resources.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eisSuccessful()\u003c/code\u003e provides a boolean indicator for quickly checking if the operation completed without errors.\u003c/p\u003e\n"]]],[],null,["# AdsApp.MutateResult\n\nThe result of a Mutate operation. Either error or resourceName will be specified if the operation failed or succeeded respectively.\n\n### Methods:\n\n| Member | Type | Description |\n|-----------------------------------------|------------|------------------------------------------------------------------------------------------|\n| [getErrorMessages()](#getErrorMessages) | `String[]` | If the operation failed, this will return the error messages. |\n| [getResourceName()](#getResourceName) | `String` | If the operation succeeded, this will return the resource name of the affected entity. |\n| [isSuccessful()](#isSuccessful) | `boolean` | Returns `true` if the associated mutate completed successfully, or `false` if it failed. |\n\n`getErrorMessages()`\n--------------------\n\nIf the operation failed, this will return the error messages. If the operation succeeded, this will return an empty array.\n\n### Return values:\n\n| Type | Description |\n|------------|--------------------------------------------------------------------------------|\n| `String[]` | The error messages if the operation failed, or an empty array if it succeeded. |\n\n`getResourceName()`\n-------------------\n\nIf the operation succeeded, this will return the resource name of the affected entity. For update and remove operations, this will match the resourceName specified in the Mutate. For create operations, this will return the resourceName for the newly created entity.\n\nIf the operation failed, this wil return `null`.\n\n### Return values:\n\n| Type | Description |\n|----------|----------------------------------------------------------------------------------------|\n| `String` | The mutated entity's resource name if the operation succeeded, or `null` if it failed. |\n\n`isSuccessful()`\n----------------\n\nReturns `true` if the associated mutate completed successfully, or `false` if it failed.\n\n### Return values:\n\n| Type | Description |\n|-----------|-------------|\n| `boolean` | |"]]
