TumblingWindowTrigger interface
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).
- Extends
Properties
delay | 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])). |
depends |
Triggers that this trigger depends on. Only tumbling window triggers are supported. |
end |
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 | The frequency of the time windows. |
interval | The interval of the time windows. The minimum interval allowed is 15 Minutes. |
max |
The max number of parallel time windows (ready for execution) for which a new run is triggered. |
pipeline | Pipeline for which runs are created when an event is fired for trigger window that is ready. |
retry |
Retry policy that will be applied for failed pipeline runs. |
start |
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 | Polymorphic discriminator, which specifies the different types this object can be |
Inherited Properties
annotations | List of tags that can be used for describing the trigger. |
description | Trigger description. |
runtime |
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. |
Property Details
delay
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])).
delay?: any
Property Value
any
dependsOn
Triggers that this trigger depends on. Only tumbling window triggers are supported.
dependsOn?: DependencyReferenceUnion[]
Property Value
endTime
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.
endTime?: Date
Property Value
Date
frequency
The frequency of the time windows.
frequency: string
Property Value
string
interval
The interval of the time windows. The minimum interval allowed is 15 Minutes.
interval: number
Property Value
number
maxConcurrency
The max number of parallel time windows (ready for execution) for which a new run is triggered.
maxConcurrency: number
Property Value
number
pipeline
Pipeline for which runs are created when an event is fired for trigger window that is ready.
pipeline: TriggerPipelineReference
Property Value
retryPolicy
Retry policy that will be applied for failed pipeline runs.
retryPolicy?: RetryPolicy
Property Value
startTime
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.
startTime: Date
Property Value
Date
type
Polymorphic discriminator, which specifies the different types this object can be
type: "TumblingWindowTrigger"
Property Value
"TumblingWindowTrigger"
Inherited Property Details
annotations
List of tags that can be used for describing the trigger.
annotations?: any[]
Property Value
any[]
Inherited From Trigger.annotations
description
runtimeState
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.
runtimeState?: string
Property Value
string
Inherited From Trigger.runtimeState