Trigger.TriggerInfo (Google Cloud Dataflow SDK 1.9.1 API)

Google Cloud Dataflow SDK for Java, version 1.9.1

Warning: Dataflow SDK 1.x for Java is unsupported as of October 16, 2018. After August 12, 2020, you can use unsupported SDKs temporarily while you upgrade your pipelines. For more information, see Using an unsupported SDK.

For information on migrating from the 1.x SDK, see Migrating from Dataflow SDK 1.x for Java.

Note: If you are using Cloud Dataflow SDK version 2.x, see the Apache Beam API reference documentation.

com.google.cloud.dataflow.sdk.transforms.windowing

Interface Trigger.TriggerInfo<W extends BoundedWindow>

• All Known Subinterfaces:

  Trigger.MergingTriggerInfo<W>

  Enclosing class:

  Trigger<W extends BoundedWindow>

  ---

  
  

  public static interface Trigger.TriggerInfo<W extends BoundedWindow>

  Interface for accessing information about the trigger being executed and other triggers in the same tree.

• • Method Summary

    All Methods Instance Methods Abstract Methods 

    Modifier and Type	Method and Description
    boolean	areAllSubtriggersFinished() Returns true if all the sub-triggers of the current trigger are marked finished.
    com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W>	firstUnfinishedSubTrigger() Returns the first unfinished sub-trigger.
    boolean	isFinished() Returns true if the current trigger is marked finished.
    boolean	isFinished(int subtriggerIndex) Return true if the given subtrigger is marked finished.
    boolean	isMerging() Returns true if the windowing strategy of the current PCollection is a merging WindowFn.
    void	resetTree() Clears all keyed state for triggers in the current sub-tree and unsets all the associated finished bits.
    void	setFinished(boolean finished) Sets the finished bit for the current trigger.
    void	setFinished(boolean finished, int subTriggerIndex) Sets the finished bit for the given sub-trigger.
    com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W>	subTrigger(int subtriggerIndex) Access the executable version of the specified sub-trigger.
    Iterable<com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W>>	subTriggers() Access the executable versions of the sub-triggers of the current trigger.
    Iterable<com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W>>	unfinishedSubTriggers() Returns an iterable over the unfinished sub-triggers of the current trigger.

• • Method Detail

    • isMerging

      boolean isMerging()

      Returns true if the windowing strategy of the current PCollection is a merging WindowFn. If true, the trigger execution needs to keep enough information to support the possibility of Trigger.onMerge(com.google.cloud.dataflow.sdk.transforms.windowing.Trigger<W>.OnMergeContext) being called. If false, Trigger.onMerge(com.google.cloud.dataflow.sdk.transforms.windowing.Trigger<W>.OnMergeContext) will never be called.

    • subTriggers

      Iterable<com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W>> subTriggers()

      Access the executable versions of the sub-triggers of the current trigger.

    • subTrigger

      com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W> subTrigger(int subtriggerIndex)

      Access the executable version of the specified sub-trigger.

    • isFinished

      boolean isFinished()

      Returns true if the current trigger is marked finished.

    • isFinished

      boolean isFinished(int subtriggerIndex)

      Return true if the given subtrigger is marked finished.

    • areAllSubtriggersFinished

      boolean areAllSubtriggersFinished()

      Returns true if all the sub-triggers of the current trigger are marked finished.

    • unfinishedSubTriggers

      Iterable<com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W>> unfinishedSubTriggers()

      Returns an iterable over the unfinished sub-triggers of the current trigger.

    • firstUnfinishedSubTrigger

      com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W> firstUnfinishedSubTrigger()

      Returns the first unfinished sub-trigger.

    • resetTree

      void resetTree()
              throws Exception

      Clears all keyed state for triggers in the current sub-tree and unsets all the associated finished bits.

      Throws:

      Exception

    • setFinished

      void setFinished(boolean finished)

      Sets the finished bit for the current trigger.

    • setFinished

      void setFinished(boolean finished,
                       int subTriggerIndex)

      Sets the finished bit for the given sub-trigger.