Trigger.OnElementContext (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

Class Trigger.OnElementContext

• java.lang.Object
• • com.google.cloud.dataflow.sdk.transforms.windowing.Trigger.TriggerContext
  • • com.google.cloud.dataflow.sdk.transforms.windowing.Trigger.OnElementContext

• Enclosing class:

  Trigger<W extends BoundedWindow>

  ---

  
  

  public abstract class Trigger.OnElementContext
  extends Trigger.TriggerContext

  Extended Trigger.TriggerContext containing information accessible to the Trigger.onElement(com.google.cloud.dataflow.sdk.transforms.windowing.Trigger<W>.OnElementContext) operational hook.

• • Constructor Summary

    Constructors 

    Constructor and Description
    OnElementContext()

  • Method Summary

    All Methods Instance Methods Abstract Methods 

    Modifier and Type	Method and Description
    abstract Instant	eventTimestamp() The event timestamp of the element currently being processed.
    abstract Trigger.OnElementContext	forTrigger(com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W> trigger) Create an OnElementContext for executing the given trigger.
    abstract void	setTimer(Instant timestamp, com.google.cloud.dataflow.sdk.util.TimeDomain domain) Sets a timer to fire when the watermark or processing time is beyond the given timestamp.

    • Methods inherited from class com.google.cloud.dataflow.sdk.transforms.windowing.Trigger.TriggerContext

      currentEventTime, currentProcessingTime, currentSynchronizedProcessingTime, deleteTimer, state, trigger, window

    • Methods inherited from class java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• • Constructor Detail

    • OnElementContext

      public OnElementContext()

  • Method Detail

    • eventTimestamp

      public abstract Instant eventTimestamp()

      The event timestamp of the element currently being processed.

    • setTimer

      public abstract void setTimer(Instant timestamp,
                                    com.google.cloud.dataflow.sdk.util.TimeDomain domain)

      Sets a timer to fire when the watermark or processing time is beyond the given timestamp. Timers are not guaranteed to fire immediately, but will be delivered at some time afterwards.

      As with Trigger.TriggerContext.state(), timers are implicitly scoped to the current window. All timer firings for a window will be received, but the implementation should choose to ignore those that are not applicable.

      Parameters:

      timestamp - the time at which the trigger should be re-evaluated

      domain - the domain that the timestamp applies to

    • forTrigger

      public abstract Trigger.OnElementContext forTrigger(com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W> trigger)

      Create an OnElementContext for executing the given trigger.

      Specified by:

      forTrigger in class Trigger.TriggerContext