TumblingWindowTrigger Class

Definition

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

public class TumblingWindowTrigger : Azure.ResourceManager.DataFactory.Models.DataFactoryTriggerProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.TumblingWindowTrigger>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.TumblingWindowTrigger>
public class TumblingWindowTrigger : Azure.ResourceManager.DataFactory.Models.DataFactoryTriggerProperties
type TumblingWindowTrigger = class
    inherit DataFactoryTriggerProperties
    interface IJsonModel<TumblingWindowTrigger>
    interface IPersistableModel<TumblingWindowTrigger>
type TumblingWindowTrigger = class
    inherit DataFactoryTriggerProperties
Public Class TumblingWindowTrigger
Inherits DataFactoryTriggerProperties
Implements IJsonModel(Of TumblingWindowTrigger), IPersistableModel(Of TumblingWindowTrigger)
Public Class TumblingWindowTrigger
Inherits DataFactoryTriggerProperties
Inheritance
TumblingWindowTrigger
Implements

Constructors

TumblingWindowTrigger(TriggerPipelineReference, TumblingWindowFrequency, Int32, DateTimeOffset, Int32)

Initializes a new instance of TumblingWindowTrigger.

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
(Inherited from DataFactoryTriggerProperties)
Annotations

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

To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
(Inherited from DataFactoryTriggerProperties)
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 DataFactoryTriggerProperties)
EndOn

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 DataFactoryTriggerProperties)
StartOn

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.

Explicit Interface Implementations

IJsonModel<DataFactoryTriggerProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from DataFactoryTriggerProperties)
IJsonModel<DataFactoryTriggerProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from DataFactoryTriggerProperties)
IJsonModel<TumblingWindowTrigger>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<TumblingWindowTrigger>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<DataFactoryTriggerProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from DataFactoryTriggerProperties)
IPersistableModel<DataFactoryTriggerProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from DataFactoryTriggerProperties)
IPersistableModel<DataFactoryTriggerProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from DataFactoryTriggerProperties)
IPersistableModel<TumblingWindowTrigger>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<TumblingWindowTrigger>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<TumblingWindowTrigger>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to