ActorStartOptions

Options shared by every method that sends a request to the API.

Hierarchy

• TimeoutOptions
  • ActorStartOptions

Index

Properties

• build
• contentType
• forcePermissionLevel
• maxItems
• maxTotalChargeUsd
• memory
• restartOnError
• runTimeoutSecs
• signal
• timeoutSecs
• waitForFinish
• webhooks

Properties

optionalbuild

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).

optionalcontentType

contentType?: string

Content type of the request body, which becomes the content type of the run's INPUT record. Without it, an input is serialized to JSON and sent as application/json. Pairing an object with application/x-www-form-urlencoded form-encodes it instead.

optionalforcePermissionLevel

forcePermissionLevel?: ACTOR_PERMISSION_LEVEL

Override the Actor's permissions for this run. If not set, the Actor will run with permissions configured in the Actor settings.

Added in 2.17.0

optionalmaxItems

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.

Added in 2.7.0

optionalmaxTotalChargeUsd

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.

Added in 2.9.7

optionalmemory

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.

optionalrestartOnError

restartOnError?: boolean

Determines whether the run will be restarted if it fails.

optionalrunTimeoutSecs

runTimeoutSecs?: number

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

optionalinheritedsignal

signal?: AbortSignal

Inherited from TimeoutOptions.signal

Aborts the method. Once the signal aborts, the request in flight is ended, no retry or further poll follows, and the method rejects with the signal's reason.

optionalinheritedtimeoutSecs

timeoutSecs?: Timeout

Inherited from TimeoutOptions.timeoutSecs

Timeout for the API request: a tier name ('short', 'medium', 'long'), a number of seconds, or 'noTimeout'. Defaults to the tier the method is assigned, which its documentation names.

optionalwaitForFinish

waitForFinish?: number

Maximum time to wait for the Actor run to finish, in seconds. If the limit is reached, the returned promise is resolved to a run object that will have status READY or RUNNING and it will not contain the Actor run output. By default (or when waitForFinish is set to 0), the function resolves immediately without waiting. The wait is limited to 60s and happens on the API directly, as opposed to the call method and its waitSecs option, which is implemented via polling on the client side instead (and has no limit like that).

optionalwebhooks

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.