Package org.apache.beam.sdk.transforms.windowing

Class OrFinallyTrigger

  • All Implemented Interfaces:
    java.io.Serializable
    public class OrFinallyTrigger
extends Trigger
    A Trigger that executes according to its main trigger until its "finally" trigger fires.

    Uniquely among triggers, the "finally" trigger's predicate is applied to all input seen so far, not input since the last firing.

    See Also:
    Serialized Form

    • Method Detail

      • getMainTrigger

        public Trigger getMainTrigger()
        The main trigger, which will continue firing until the "until" trigger fires. See getUntilTrigger()

      • getUntilTrigger

        public Trigger.OnceTrigger getUntilTrigger()
        The trigger that signals termination of this trigger.

      • getWatermarkThatGuaranteesFiring

        public org.joda.time.Instant getWatermarkThatGuaranteesFiring​(BoundedWindow window)
        Description copied from class: Trigger
        For internal use only; no backwards-compatibility guarantees.

        Returns a bound in event time by which this trigger would have fired at least once for a given window had there been input data.

        For triggers that do not fire based on the watermark advancing, returns BoundedWindow.TIMESTAMP_MAX_VALUE.

        This estimate may be used, for example, to determine that there are no elements in a side-input window, which causes the default value to be used instead.

        Specified by:
        getWatermarkThatGuaranteesFiring in class Trigger

      • mayFinish

        public boolean mayFinish()
        Description copied from class: Trigger
        For internal use only; no backwards-compatibility guarantees.

        Indicates whether this trigger may "finish". A top level trigger that finishes can cause data loss, so is rejected by GroupByKey validation.

        Specified by:
        mayFinish in class Trigger

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class Trigger