Metadata API Developer Guide

Introduction to Metadata API
Using Metadata API
Metadata API Context MCP Tool (Beta)
Reference
File-Based Calls
CRUD-Based Calls
Utility Calls
Result Objects
AsyncResult
CancelDeployResult
DeployResult
DescribeMetadataResult
DescribeValueTypeResult
ReadResult
RetrieveResult
SaveResult
DeleteResult
UpsertResult
Error
Metadata Types
Headers
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

CancelDeployResult

Contains information about a deployment cancellation—whether the cancellation completed and the deployment ID.

The asynchronous metadata call cancelDeploy() returns a CancelDeployResult object.

Version

Available in API version 30.0 and later.

CancelDeployResult has the following properties.

Name Type Description
done boolean Indicates whether the deployment cancellation, which is started through cancelDeploy(), has completed (true) or not (false).

When a deployment hasn’t started yet and is still in the queue, the deployment is canceled immediately with the cancelDeploy() call and this field returns true. Otherwise, this field returns false when the cancellation is in progress.
id ID ID of the deployment being canceled.