TumblingWindowTrigger Class

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).

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

TumblingWindowTrigger(*, pipeline: _models.TriggerPipelineReference, frequency: str | _models.TumblingWindowFrequency, interval: int, start_time: datetime, max_concurrency: int, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None, annotations: List[MutableMapping[str, Any]] | None = None, end_time: datetime | None = None, delay: MutableMapping[str, Any] | None = None, retry_policy: _models.RetryPolicy | None = None, depends_on: List[_models.DependencyReference] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection. Default value: None
description	str Trigger description. Default value: None
annotations	list[<xref:JSON>] List of tags that can be used for describing the trigger. Default value: None
pipeline	TriggerPipelineReference Pipeline for which runs are created when an event is fired for trigger window that is ready. Required.
frequency	str or TumblingWindowFrequency The frequency of the time windows. Required. Known values are: "Minute", "Hour", and "Month".
interval	int The interval of the time windows. The minimum interval allowed is 15 Minutes. Required.
start_time	datetime 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. Required.
end_time	datetime 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. Default value: None
delay	<xref:JSON> 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+).)?(dd):(60\|([0-5][0-9])):(60\|([0-5][0-9])). Default value: None
max_concurrency	int The max number of parallel time windows (ready for execution) for which a new run is triggered. Required.
retry_policy	RetryPolicy Retry policy that will be applied for failed pipeline runs. Default value: None
depends_on	list[DependencyReference] Triggers that this trigger depends on. Only tumbling window triggers are supported. Default value: None

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
type	str Trigger type. Required.
description	str Trigger description.
runtime_state	str or TriggerRuntimeState Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Known values are: "Started", "Stopped", and "Disabled".
annotations	list[<xref:JSON>] List of tags that can be used for describing the trigger.
pipeline	TriggerPipelineReference Pipeline for which runs are created when an event is fired for trigger window that is ready. Required.
frequency	str or TumblingWindowFrequency The frequency of the time windows. Required. Known values are: "Minute", "Hour", and "Month".
interval	int The interval of the time windows. The minimum interval allowed is 15 Minutes. Required.
start_time	datetime 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. Required.
end_time	datetime 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.
delay	<xref:JSON> 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+).)?(dd):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
max_concurrency	int The max number of parallel time windows (ready for execution) for which a new run is triggered. Required.
retry_policy	RetryPolicy Retry policy that will be applied for failed pipeline runs.
depends_on	list[DependencyReference] Triggers that this trigger depends on. Only tumbling window triggers are supported.

Feedback

Was this page helpful?