AdsApp.​MutateResult

  • A MutateResult indicates the outcome of a Mutate operation, specifying either an error or a resource name.

  • The getErrorMessages() method provides error messages if the operation failed.

  • The getResourceName() method returns the resource name of the affected entity if the operation succeeded.

  • The isSuccessful() method indicates whether the mutate operation completed successfully.

 The result of a Mutate operation. Either error or resourceName will be specified if the operation failed or succeeded respectively.

Methods:

MemberTypeDescription
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:

TypeDescription
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:

TypeDescription
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:

TypeDescription
boolean