Package com.azure.analytics.synapse.artifacts.models

Class TumblingWindowTrigger

  • public class TumblingWindowTrigger
extends Trigger
    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).

    • Constructor Detail

      • TumblingWindowTrigger

        public TumblingWindowTrigger()

    • Method Detail

      • getPipeline

        public TriggerPipelineReference getPipeline()
        Get the pipeline property: Pipeline for which runs are created when an event is fired for trigger window that is ready.
        Returns:
        the pipeline value.

      • setPipeline

        public TumblingWindowTrigger setPipeline​(TriggerPipelineReference pipeline)
        Set the pipeline property: Pipeline for which runs are created when an event is fired for trigger window that is ready.
        Parameters:
        pipeline - the pipeline value to set.
        Returns:
        the TumblingWindowTrigger object itself.

      • getFrequency

        public TumblingWindowFrequency getFrequency()
        Get the frequency property: The frequency of the time windows.
        Returns:
        the frequency value.

      • setFrequency

        public TumblingWindowTrigger setFrequency​(TumblingWindowFrequency frequency)
        Set the frequency property: The frequency of the time windows.
        Parameters:
        frequency - the frequency value to set.
        Returns:
        the TumblingWindowTrigger object itself.

      • getInterval

        public int getInterval()
        Get the interval property: The interval of the time windows. The minimum interval allowed is 15 Minutes.
        Returns:
        the interval value.

      • setInterval

        public TumblingWindowTrigger setInterval​(int interval)
        Set the interval property: The interval of the time windows. The minimum interval allowed is 15 Minutes.
        Parameters:
        interval - the interval value to set.
        Returns:
        the TumblingWindowTrigger object itself.

      • getStartTime

        public OffsetDateTime getStartTime()
        Get the startTime property: 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.
        Returns:
        the startTime value.

      • setStartTime

        public TumblingWindowTrigger setStartTime​(OffsetDateTime startTime)
        Set the startTime property: 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.
        Parameters:
        startTime - the startTime value to set.
        Returns:
        the TumblingWindowTrigger object itself.

      • getEndTime

        public OffsetDateTime getEndTime()
        Get the endTime property: 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.
        Returns:
        the endTime value.

      • setEndTime

        public TumblingWindowTrigger setEndTime​(OffsetDateTime endTime)
        Set the endTime property: 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.
        Parameters:
        endTime - the endTime value to set.
        Returns:
        the TumblingWindowTrigger object itself.

      • getDelay

        public Object getDelay()
        Get the delay property: 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])).
        Returns:
        the delay value.

      • setDelay

        public TumblingWindowTrigger setDelay​(Object delay)
        Set the delay property: 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])).
        Parameters:
        delay - the delay value to set.
        Returns:
        the TumblingWindowTrigger object itself.

      • getMaxConcurrency

        public int getMaxConcurrency()
        Get the maxConcurrency property: The max number of parallel time windows (ready for execution) for which a new run is triggered.
        Returns:
        the maxConcurrency value.

      • setMaxConcurrency

        public TumblingWindowTrigger setMaxConcurrency​(int maxConcurrency)
        Set the maxConcurrency property: The max number of parallel time windows (ready for execution) for which a new run is triggered.
        Parameters:
        maxConcurrency - the maxConcurrency value to set.
        Returns:
        the TumblingWindowTrigger object itself.

      • getRetryPolicy

        public RetryPolicy getRetryPolicy()
        Get the retryPolicy property: Retry policy that will be applied for failed pipeline runs.
        Returns:
        the retryPolicy value.

      • setRetryPolicy

        public TumblingWindowTrigger setRetryPolicy​(RetryPolicy retryPolicy)
        Set the retryPolicy property: Retry policy that will be applied for failed pipeline runs.
        Parameters:
        retryPolicy - the retryPolicy value to set.
        Returns:
        the TumblingWindowTrigger object itself.

      • getDependsOn

        public List<DependencyReference> getDependsOn()
        Get the dependsOn property: Triggers that this trigger depends on. Only tumbling window triggers are supported.
        Returns:
        the dependsOn value.

      • setDependsOn

        public TumblingWindowTrigger setDependsOn​(List<DependencyReference> dependsOn)
        Set the dependsOn property: Triggers that this trigger depends on. Only tumbling window triggers are supported.
        Parameters:
        dependsOn - the dependsOn value to set.
        Returns:
        the TumblingWindowTrigger object itself.

      • setDescription

        public TumblingWindowTrigger setDescription​(String description)
        Set the description property: Trigger description.
        Overrides:
        setDescription in class Trigger
        Parameters:
        description - the description value to set.
        Returns:
        the Trigger object itself.

      • setAnnotations

        public TumblingWindowTrigger setAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the trigger.
        Overrides:
        setAnnotations in class Trigger
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the Trigger object itself.