TumblingWindowTrigger Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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).
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.TumblingWindowTrigger+TumblingWindowTriggerConverter))]
public class TumblingWindowTrigger : Azure.Analytics.Synapse.Artifacts.Models.Trigger
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.TumblingWindowTrigger+TumblingWindowTriggerConverter))>]
type TumblingWindowTrigger = class
inherit Trigger
Public Class TumblingWindowTrigger
Inherits Trigger
- Inheritance
- Attributes
Constructors
TumblingWindowTrigger(TriggerPipelineReference, TumblingWindowFrequency, Int32, DateTimeOffset, Int32) |
Initializes a new instance of TumblingWindowTrigger. |
Properties
AdditionalProperties |
Additional Properties. (Inherited from Trigger) |
Annotations |
List of tags that can be used for describing the trigger. (Inherited from Trigger) |
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])). |
DependsOn |
Triggers that this trigger depends on. Only tumbling window triggers are supported. Please note DependencyReference is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SelfDependencyTumblingWindowTriggerReference, TriggerDependencyReference and TumblingWindowTriggerDependencyReference. |
Description |
Trigger description. (Inherited from Trigger) |
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. |
Frequency |
The frequency of the time windows. |
Interval |
The interval of the time windows. The minimum interval allowed is 15 Minutes. |
MaxConcurrency |
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. |
RetryPolicy |
Retry policy that will be applied for failed pipeline runs. |
RuntimeState |
Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. (Inherited from Trigger) |
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. |