Package version:

Interface TumblingWindowTrigger

Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).

interface TumblingWindowTrigger {
    annotations?: any[];
    delay?: any;
    dependsOn?: DependencyReferenceUnion[];
    description?: string;
    endTime?: any;
    frequency: string;
    interval: number;
    maxConcurrency: number;
    pipeline: TriggerPipelineReference;
    retryPolicy?: RetryPolicy;
    runtimeState?: string;
    startTime: Date;
    type: "TumblingWindowTrigger";
}

Hierarchy (view full)

Properties

annotations? delay? dependsOn? description? endTime? frequency interval maxConcurrency pipeline retryPolicy? runtimeState? startTime type

Properties

Optionalannotations

annotations?: any[]

List of tags that can be used for describing the trigger.

Optionaldelay

delay?: any

Specifies how long the trigger waits past due time before triggering new run. It doesn't alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

OptionaldependsOn

dependsOn?: DependencyReferenceUnion[]

Triggers that this trigger depends on. Only tumbling window triggers are supported.

Optionaldescription

description?: string

Trigger description.

OptionalendTime

endTime?: any

The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.

frequency

frequency: string

The frequency of the time windows.

interval

interval: number

The interval of the time windows. The minimum interval allowed is 15 Minutes.

maxConcurrency

maxConcurrency: number

The max number of parallel time windows (ready for execution) for which a new run is triggered.

pipeline

pipeline: TriggerPipelineReference

Pipeline for which runs are created when an event is fired for trigger window that is ready.

OptionalretryPolicy

retryPolicy?: RetryPolicy

Retry policy that will be applied for failed pipeline runs.

Optional ReadonlyruntimeState

runtimeState?: string

Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. NOTE: This property will not be serialized. It can only be populated by the server.

startTime

startTime: Date

The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.

type

type

Polymorphic discriminator, which specifies the different types this object can be

Settings

Member Visibility