Class TumblingWindowTrigger


  • public final 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

      • pipeline

        public TriggerPipelineReference pipeline()
        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.
      • withPipeline

        public TumblingWindowTrigger withPipeline​(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.
      • withDescription

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

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

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

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

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

        public TumblingWindowTrigger withInterval​(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.
      • startTime

        public OffsetDateTime startTime()
        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.
      • withStartTime

        public TumblingWindowTrigger withStartTime​(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.
      • endTime

        public OffsetDateTime endTime()
        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.
      • withEndTime

        public TumblingWindowTrigger withEndTime​(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.
      • delay

        public Object delay()
        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.
      • withDelay

        public TumblingWindowTrigger withDelay​(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.
      • maxConcurrency

        public int maxConcurrency()
        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.
      • withMaxConcurrency

        public TumblingWindowTrigger withMaxConcurrency​(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.
      • retryPolicy

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

        public TumblingWindowTrigger withRetryPolicy​(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.
      • dependsOn

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

        public TumblingWindowTrigger withDependsOn​(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.