BuildClient
Hierarchy
- ResourceClient
- BuildClient
Index
Properties
apifyClient
baseUrl
httpClient
optionalid
optionalparams
resourcePath
optionalsafeId
url
Methods
abort
Returns Promise<Build>
delete
Returns Promise<void>
get
Parameters
options: BuildClientGetOptions = {}
Returns Promise<undefined | Build>
log
Returns LogClient
waitForFinish
Returns a promise that resolves with the finished Build object when the provided actor build finishes or with the unfinished Build object when the
waitSecs
timeout lapses. The promise is NOT rejected based on run status. You can inspect thestatus
property of the Build object to find out its status.The difference between this function and the
waitForFinish
parameter of theget
method is the fact that this function can wait indefinitely. Its use is preferable to thewaitForFinish
parameter alone, which it uses internally.This is useful when you need to immediately start a run after a build finishes.
Parameters
options: BuildClientWaitForFinishOptions = {}
Returns Promise<Build>
https://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build