Interface InterruptActivity

interface InterruptActivity {
    ancestors?: string[];
    code?: number;
    collationInt?: number;
    consumes?: Consumes;
    cycle?: boolean;
    descend?: boolean;
    emit?: boolean;
    entity?: string;
    escalation?: Record<string, any>;
    expire?: number;
    hook?: Record<string, any>;
    input?: Record<string, any>;
    job?: Record<string, any>;
    output?: Record<string, any>;
    parent?: string;
    persist?: boolean;
    persistent?: boolean;
    produces?: string[];
    PRODUCES?: string[];
    publishes?: string;
    reason?: string;
    retry?: StreamRetryPolicy;
    settings?: Record<string, any>;
    sleep?: number;
    stack?: string;
    statusThreshold?: number;
    statusThresholdType?: "stop" | "throw" | "stall";
    subscribes?: string;
    subtype?: string;
    target?: string;
    telemetry?: Record<string, any>;
    throw?: boolean;
    title?: string;
    topic?: string;
    trigger?: string;
    type: "interrupt";
}

Hierarchy (view full)

Properties

ancestors? code? collationInt? consumes? cycle? descend? emit? entity? escalation? expire? hook? input? job? output? parent? persist? persistent? produces? PRODUCES? publishes? reason? retry? settings? sleep? stack? statusThreshold? statusThresholdType? subscribes? subtype? target? telemetry? throw? title? topic? trigger? type

Properties

Optionalancestors

ancestors?: string[]

Optionalcode

code?: number

Optional Error Code; will be used as the error code when thrown

Default

410

OptionalcollationInt

collationInt?: number

Optionalconsumes

consumes?: Consumes

Optionalcycle

cycle?: boolean

Optionaldescend

descend?: boolean

Interrupt child/descendant jobs

Default

false

Optionalemit

emit?: boolean

Optionalentity

entity?: string

Optionalescalation

escalation?: Record<string, any>

When present on a hook activity, writes a row to public.hmsh_escalations at suspension time. Values may use @pipe expressions resolved against the current job context.

Optionalexpire

expire?: number

Optionalhook

hook?: Record<string, any>

Optionalinput

input?: Record<string, any>

Optionaljob

job?: Record<string, any>

Optionaloutput

output?: Record<string, any>

Optionalparent

parent?: string

Optionalpersist

persist?: boolean

Optionalpersistent

persistent?: boolean

Optionalproduces

produces?: string[]

OptionalPRODUCES

PRODUCES?: string[]

Optionalpublishes

publishes?: string

Optionalreason

reason?: string

Optional Reason; will be used as the error message when thrown

Default

'Job Interrupted'

Optionalretry

retry?: StreamRetryPolicy

Optionalsettings

settings?: Record<string, any>

Optionalsleep

sleep?: number

Optionalstack

stack?: string

Optional stack trace

OptionalstatusThreshold

statusThreshold?: number

OptionalstatusThresholdType

statusThresholdType?: "stop" | "throw" | "stall"

Optionalsubscribes

subscribes?: string

Optionalsubtype

subtype?: string

Optionaltarget

target?: string

Target job id (if not present the current job will be targeted)

Optionaltelemetry

telemetry?: Record<string, any>

Optionalthrow

throw?: boolean

throw JobInterrupted error upon interrupting

Default

true

Optionaltitle

title?: string

Optionaltopic

topic?: string

Optional topic to publish the interrupt message (if not present the current job topic will be used

Optionaltrigger

trigger?: string

type

type

Settings

Member Visibility

On This Page

Properties