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.