Method: googleapis.cloudbuild.v1.projects.builds.cancel

Cancels a build in progress.

Arguments

Parameters
id

string

Required. ID of the build.

projectId

string

Required. ID of the project.

body

object ( CancelBuildRequest )

Required.

Raised exceptions

Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of Build .

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation .

YAML

 - 
  
 cancel 
 : 
  
 call 
 : 
  
 googleapis.cloudbuild.v1.projects.builds.cancel 
  
 args 
 : 
  
 id 
 : 
  
 ... 
  
 projectId 
 : 
  
 ... 
  
 body 
 : 
  
 id 
 : 
  
 ... 
  
 name 
 : 
  
 ... 
  
 projectId 
 : 
  
 ... 
  
 result 
 : 
  
 cancelResult 

JSON

 [ 
  
 { 
  
 "cancel" 
 : 
  
 { 
  
 "call" 
 : 
  
 "googleapis.cloudbuild.v1.projects.builds.cancel" 
 , 
  
 "args" 
 : 
  
 { 
  
 "id" 
 : 
  
 "..." 
 , 
  
 "projectId" 
 : 
  
 "..." 
 , 
  
 "body" 
 : 
  
 { 
  
 "id" 
 : 
  
 "..." 
 , 
  
 "name" 
 : 
  
 "..." 
 , 
  
 "projectId" 
 : 
  
 "..." 
  
 } 
  
 }, 
  
 "result" 
 : 
  
 "cancelResult" 
  
 } 
  
 } 
 ] 
Design a Mobile Site
View Site in Mobile | Classic
Share by: