Version: Next

TaskCallOptions

Hierarchy

Omit<TaskStartOptions, waitForFinish>
- TaskCallOptions

Index

Properties

build
maxItems
maxTotalChargeUsd
memory
restartOnError
timeout
waitSecs
webhooks

Properties

optionalinheritedbuild

build?: string

Tag or number of the actor build to run (e.g. beta or 1.2.345). If not provided, the run uses build tag or number from the default actor run configuration (typically latest).

optionalinheritedmaxItems

maxItems?: number

Specifies the maximum number of dataset items that will be charged for pay-per-result Actors. This does NOT guarantee that the Actor will return only this many items. It only ensures you won't be charged for more than this number of items. Only works for pay-per-result Actors. Value can be accessed in the Actor run using ACTOR_MAX_PAID_DATASET_ITEMS environment variable.

optionalinheritedmaxTotalChargeUsd

maxTotalChargeUsd?: number

Specifies the maximum cost of the Actor run. This parameter is used only for pay-per-event Actors. It allows you to limit the amount charged to your subscription. You can access the maximum cost in your Actor by using the ACTOR_MAX_TOTAL_CHARGE_USD environment variable.

optionalinheritedmemory

memory?: number

Memory in megabytes which will be allocated for the new actor run. If not provided, the run uses memory of the default actor run configuration.

optionalinheritedrestartOnError

restartOnError?: boolean

Determines whether the run will be restarted if it fails.

optionalinheritedtimeout

timeout?: number

Timeout for the actor run in seconds. Zero value means there is no timeout. If not provided, the run uses timeout of the default actor run configuration.

optionalwaitSecs

waitSecs?: number

optionalinheritedwebhooks

webhooks?: readonly WebhookUpdateData[]

Specifies optional webhooks associated with the actor run, which can be used to receive a notification e.g. when the actor finished or failed, see ad hook webhooks documentation for detailed description.