Function: deleteBuildByKey()

function deleteBuildByKey(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/agile/api/builds.ts:101

Delete the build data currently stored for the given pipelineId and buildNumber combination.

Deletion is performed asynchronously. The getBuildByKey operation can be used to confirm that data has been deleted successfully (if needed).

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ buildNumber: number; pipelineId: string; }	-
parameters.buildNumber	number	The buildNumber of the build to delete.
parameters.pipelineId?	string	The pipelineId of the build to delete.
options?	RequestOptions	-

Returns

Promise<void>