AI-generated Key Takeaways
-
This documentation describes the
MutateOperation.Resultobject, which indicates the outcome of a Mutate operation. -
The result provides information about success or failure, including error messages if applicable.
-
Access methods are available to retrieve error messages, the resource name of the affected entity, and overall operation status.
-
getResourceName()returns the name of the affected entity on success, useful for identifying created or modified resources. -
isSuccessful()provides a boolean indicator for quickly checking if the operation completed without errors.
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:
| Type | Description |
|---|---|
boolean |