RunClient

Hierarchy

• ResourceClient
  • RunClient

Index

Properties

• apifyClient
• baseUrl
• httpClient
• id
• params
• resourcePath
• safeId
• url

Methods

• abort
• charge
• dataset
• delete
• get
• keyValueStore
• log
• metamorph
• reboot
• requestQueue
• resurrect
• update
• waitForFinish

Properties

inheritedapifyClient

apifyClient: ApifyClient

Inherited from ResourceClient.apifyClient

inheritedbaseUrl

baseUrl: string

Inherited from ResourceClient.baseUrl

inheritedhttpClient

httpClient: HttpClient

Inherited from ResourceClient.httpClient

optionalinheritedid

id?: string

Inherited from ResourceClient.id

optionalinheritedparams

params?: Record<string, unknown>

Inherited from ResourceClient.params

inheritedresourcePath

resourcePath: string

Inherited from ResourceClient.resourcePath

optionalinheritedsafeId

safeId?: string

Inherited from ResourceClient.safeId

inheritedurl

url: string

Inherited from ResourceClient.url

Methods

abort

• abort(options?: RunAbortOptions): Promise<ActorRun>

• https://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run

  ---

  Parameters

  • options: RunAbortOptions = {}

  Returns Promise<ActorRun>

charge

• charge(options: RunChargeOptions): Promise<ApifyResponse<Record<string, never>>>

• https://docs.apify.com/api/v2#/reference/actor-runs/charge-run/charge-run

  ---

  Parameters

  • options: RunChargeOptions

  Returns Promise<ApifyResponse<Record<string, never>>>

dataset

• dataset(): DatasetClient<Record<string | number, unknown>>

• 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-storages

  ---

  Returns DatasetClient<Record<string | number, unknown>>

delete

• delete(): Promise<void>

• https://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run

  ---

  Returns Promise<void>

get

• get(options?: RunGetOptions): Promise<undefined | ActorRun>

• https://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run

  ---

  Parameters

  • options: RunGetOptions = {}

  Returns Promise<undefined | ActorRun>

keyValueStore

• keyValueStore(): KeyValueStoreClient

• 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-storages

  ---

  Returns KeyValueStoreClient

log

• log(): LogClient

• 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-storages

  ---

  Returns LogClient

metamorph

• metamorph(targetActorId: string, input: unknown, options?: RunMetamorphOptions): Promise<ActorRun>

• https://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run

  ---

  Parameters

  • targetActorId: string

  • input: unknown

  • options: RunMetamorphOptions = {}

  Returns Promise<ActorRun>

reboot

• reboot(): Promise<ActorRun>

• https://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run

  ---

  Returns Promise<ActorRun>

requestQueue

• requestQueue(): RequestQueueClient

• 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-storages

  ---

  Returns RequestQueueClient

resurrect

• resurrect(options?: RunResurrectOptions): Promise<ActorRun>

• https://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run

  ---

  Parameters

  • options: RunResurrectOptions = {}

  Returns Promise<ActorRun>

update

• update(newFields: RunUpdateOptions): Promise<ActorRun>

• Parameters

  • newFields: RunUpdateOptions

  Returns Promise<ActorRun>

waitForFinish

• waitForFinish(options?: RunWaitForFinishOptions): Promise<ActorRun>

• 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 the status property of the Run object to find out its status.

  The difference between this function and the waitForFinish parameter of the get method is the fact that this function can wait indefinitely. Its use is preferable to the waitForFinish 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>