RunClient
Hierarchy
- ResourceClient
- RunClient
Index
Constructors
constructor
Parameters
options: ApiClientOptionsWithOptionalResourcePath
Returns RunClient
Properties
apifyClient
baseUrl
httpClient
optionalid
optionalparams
resourcePath
optionalsafeId
url
Methods
abort
Parameters
options: RunAbortOptions = {}
Returns Promise<ActorRun>
dataset
https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages
This also works through
actorClient.lastRun().dataset()
. https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storagesReturns DatasetClient<Record<string | number, unknown>>
get
Parameters
options: RunGetOptions = {}
Returns Promise<undefined | ActorRun>
keyValueStore
https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages
This also works through
actorClient.lastRun().keyValueStore()
. https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storagesReturns KeyValueStoreClient
log
https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages
This also works through
actorClient.lastRun().log()
. https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storagesReturns LogClient
metamorph
Parameters
targetActorId: string
input: unknown
options: RunMetamorphOptions = {}
Returns Promise<ActorRun>
requestQueue
https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages
This also works through
actorClient.lastRun().requestQueue()
. https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storagesReturns RequestQueueClient
resurrect
Parameters
options: RunResurrectOptions = {}
Returns Promise<ActorRun>
update
Parameters
newFields: RunUpdateOptions
Returns Promise<ActorRun>
waitForFinish
Returns a promise that resolves with the finished Run object when the provided actor run finishes or with the unfinished Run object when the
waitSecs
timeout lapses. The promise is NOT rejected based on run status. You can inspect thestatus
property of the Run 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 chain actor executions. Similar effect can be achieved by using webhooks, so be sure to review which technique fits your use-case better.
Parameters
options: RunWaitForFinishOptions = {}
Returns Promise<ActorRun>