RunChargeOptions

Options for charging events in a pay-per-event Actor run.

Hierarchy

• TimeoutOptions
  • RunChargeOptions

Added in 2.11.0

Index

Properties

• count
• eventName
• idempotencyKey
• requestId
• signal
• timeoutSecs

Properties

optionalcount

count?: number

Defaults to 1

eventName

eventName: string

Name of the event to charge. Must be defined in the Actor's pricing info else the API will throw.

optionalidempotencyKey

idempotencyKey?: string

Defaults to runId-eventName-timestamp

optionalrequestId

requestId?: string

ID of the Server Actor request being charged, taken from the X-Actor-Request-ID header of the incoming request. Required for multi-tenant Server Actor runs, where it maps the charge to the caller's account instead of the account that started the run. Ignored elsewhere.

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.