BetaRoutinesCreateOrUpdateOptionalParams interface

Optional parameters.

Extends

Properties

action

The action executed when the routine fires.

description

A human-readable description of the routine.

enabled

Whether the routine is enabled.

foundryFeatures

A feature flag opt-in required when using preview operations or modifying persisted preview resources.

triggers

The triggers configured for the routine. In v1, exactly one trigger entry is supported.

Inherited Properties

abortSignal

The signal which can be used to abort requests.

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

requestOptions

Options used when creating and sending HTTP requests for this operation.

tracingOptions

Options used when tracing is enabled.

Property Details

action

The action executed when the routine fires.

action?: RoutineActionUnion

Property Value

description

A human-readable description of the routine.

description?: string

Property Value

string

enabled

Whether the routine is enabled.

enabled?: boolean

Property Value

boolean

foundryFeatures

A feature flag opt-in required when using preview operations or modifying persisted preview resources.

foundryFeatures?: "Routines=V1Preview"

Property Value

"Routines=V1Preview"

triggers

The triggers configured for the routine. In v1, exactly one trigger entry is supported.

triggers?: Record<string, RoutineTriggerUnion>

Property Value

Record<string, RoutineTriggerUnion>

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

Inherited From OperationOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

Inherited From OperationOptions.tracingOptions