RepeatedlyStateMachine (Apache Beam SDK for Java, version 0.4.0)

In-Reply-To: <4dff17b824994391a48a1778ff45dbe6@git.apache.org> References: <4dff17b824994391a48a1778ff45dbe6@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [15/52] [partial] beam-site git commit: Add 0.4.0 release archived-at: Wed, 04 Jan 2017 09:56:54 -0000 http://git-wip-us.apache.org/repos/asf/beam-site/blob/0c7c6b2a/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/RepeatedlyStateMachine.html ---------------------------------------------------------------------- diff --git a/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/RepeatedlyStateMachine.html b/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/RepeatedlyStateMachine.html new file mode 100644 index 0000000..275841e --- /dev/null +++ b/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/RepeatedlyStateMachine.html @@ -0,0 +1,440 @@ + + + + + + +RepeatedlyStateMachine (Apache Beam SDK for Java, version 0.4.0) + + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- org.apache.beam.runners.core.triggers.TriggerStateMachine
- +
  - org.apache.beam.runners.core.triggers.RepeatedlyStateMachine
  +
+

+
+
All Implemented Interfaces:
+
Serializable
+
+
+
+
```
public class RepeatedlyStateMachine
+extends TriggerStateMachine
```
+
Repeat a trigger, either until some condition is met or forever. + +
For example, to fire after the end of the window, and every time late data arrives: +
```
 
+     Repeatedly.forever(AfterWatermark.isPastEndOfWindow());
+  
```
+ +
Repeatedly.forever(someTrigger) behaves like an infinite + AfterEach.inOrder(someTrigger, someTrigger, someTrigger, ...).
+
+
See Also:
+
Serialized Form
+
+

+ +

+ + +
Nested Class Summary
+
- + + +
  Nested classes/interfaces inherited from class org.apache.beam.runners.core.triggers.TriggerStateMachine
  +TriggerStateMachine.MergingTriggerInfo, TriggerStateMachine.OnceTriggerStateMachine, TriggerStateMachine.OnElementContext, TriggerStateMachine.OnMergeContext, TriggerStateMachine.TriggerContext, TriggerStateMachine.TriggerInfo
+

+ +

+ + +
Field Summary
+
- + + +
  Fields inherited from class org.apache.beam.runners.core.triggers.TriggerStateMachine
  +subTriggers
+

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RepeatedlyStateMachine`	`forever(TriggerStateMachine repeated)` + Create a composite trigger that repeatedly executes the trigger `repeated`, firing each + time it fires and ignoring any indications to finish. +
`void`	`onElement(TriggerStateMachine.OnElementContext c)` + Called every time an element is incorporated into a window. +
`void`	`onFire(TriggerStateMachine.TriggerContext context)` + Adjusts the state of the trigger to be ready for the next pane. +
`void`	`onMerge(TriggerStateMachine.OnMergeContext c)` + Called immediately after windows have been merged. +
`boolean`	`shouldFire(TriggerStateMachine.TriggerContext context)` + Returns `true` if the current state of the trigger indicates that its condition + is satisfied and it is ready to fire. +
`String`	`toString()`

+ + +
Methods inherited from class org.apache.beam.runners.core.triggers.TriggerStateMachine
+clear, equals, hashCode, isCompatible, orFinally, prefetchOnElement, prefetchOnFire, prefetchOnMerge, prefetchShouldFire, subTriggers

+ + +
Methods inherited from class java.lang.Object
+clone, finalize, getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Method Detail
  + + + +
  - +
    forever
    +
```
public static RepeatedlyStateMachine forever(TriggerStateMachine repeated)
```
    +
    Create a composite trigger that repeatedly executes the trigger repeated, firing each + time it fires and ignoring any indications to finish. + +
    Unless used with TriggerStateMachine.orFinally(org.apache.beam.runners.core.triggers.TriggerStateMachine.OnceTriggerStateMachine) the composite trigger will never + finish.
    +
    +
    Parameters:
    +
    repeated - the trigger to execute repeatedly.
    +
    +
  + + + +
  - +
    onElement
    +
```
public void onElement(TriggerStateMachine.OnElementContext c)
+               throws Exception
```
    +
    Description copied from class: TriggerStateMachine
    +
    Called every time an element is incorporated into a window.
    +
    +
    Specified by:
    +
    onElement in class TriggerStateMachine
    +
    Throws:
    +
    Exception
    +
    +
  + + + +
  - +
    onMerge
    +
```
public void onMerge(TriggerStateMachine.OnMergeContext c)
+             throws Exception
```
    +
    Description copied from class: TriggerStateMachine
    +
    Called immediately after windows have been merged. + +
    Leaf triggers should update their state by inspecting their status and any state in the + merging windows. Composite triggers should update their state by calling ExecutableTriggerStateMachine.invokeOnMerge(org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext) on their sub-triggers, and applying appropriate + logic. + +
    A trigger such as AfterWatermarkStateMachine.pastEndOfWindow() may no longer be + finished; it is the responsibility of the trigger itself to record this fact. It is forbidden + for a trigger to become finished due to TriggerStateMachine.onMerge(org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext), as it has not yet fired the pending + elements that led to it being ready to fire. + +
    The implementation does not need to clear out any state associated with the old windows.
    +
    +
    Specified by:
    +
    onMerge in class TriggerStateMachine
    +
    Throws:
    +
    Exception
    +
    +
  + + + +
  - +
    shouldFire
    +
```
public boolean shouldFire(TriggerStateMachine.TriggerContext context)
+                   throws Exception
```
    +
    Description copied from class: TriggerStateMachine
    +
    Returns true if the current state of the trigger indicates that its condition + is satisfied and it is ready to fire.
    +
    +
    Specified by:
    +
    shouldFire in class TriggerStateMachine
    +
    Throws:
    +
    Exception
    +
    +
  + + + +
  - +
    onFire
    +
```
public void onFire(TriggerStateMachine.TriggerContext context)
+            throws Exception
```
    +
    Description copied from class: TriggerStateMachine
    +
    Adjusts the state of the trigger to be ready for the next pane. For example, a + RepeatedlyStateMachine trigger will reset its inner trigger, since it has fired. + +
    If the trigger is finished, it is the responsibility of the trigger itself to + record that fact via the context.
    +
    +
    Specified by:
    +
    onFire in class TriggerStateMachine
    +
    Throws:
    +
    Exception
    +
    +
  + + + +
  - +
    toString
    +
```
public String toString()
```
    +
    +
    Overrides:
    +
    toString in class TriggerStateMachine
    +
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

+ + http://git-wip-us.apache.org/repos/asf/beam-site/blob/0c7c6b2a/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/ReshuffleTriggerStateMachine.html ---------------------------------------------------------------------- diff --git a/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/ReshuffleTriggerStateMachine.html b/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/ReshuffleTriggerStateMachine.html new file mode 100644 index 0000000..63f7674 --- /dev/null +++ b/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/ReshuffleTriggerStateMachine.html @@ -0,0 +1,436 @@ + + + + + + +ReshuffleTriggerStateMachine (Apache Beam SDK for Java, version 0.4.0) + + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- org.apache.beam.runners.core.triggers.TriggerStateMachine
- +
  - org.apache.beam.runners.core.triggers.ReshuffleTriggerStateMachine
  +
+

+
+
All Implemented Interfaces:
+
Serializable
+
+
+
+
```
public class ReshuffleTriggerStateMachine
+extends TriggerStateMachine
```
+
The trigger used with Reshuffle which triggers on every element + and never buffers state.
+
+
See Also:
+
Serialized Form
+
+

+ +

+ + +
Nested Class Summary
+
- + + +
  Nested classes/interfaces inherited from class org.apache.beam.runners.core.triggers.TriggerStateMachine
  +TriggerStateMachine.MergingTriggerInfo, TriggerStateMachine.OnceTriggerStateMachine, TriggerStateMachine.OnElementContext, TriggerStateMachine.OnMergeContext, TriggerStateMachine.TriggerContext, TriggerStateMachine.TriggerInfo
+

+ +

+ + +
Field Summary
+
- + + +
  Fields inherited from class org.apache.beam.runners.core.triggers.TriggerStateMachine
  +subTriggers
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
ReshuffleTriggerStateMachine()
+

Constructors
Constructor and Description
`ReshuffleTriggerStateMachine()`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`onElement(TriggerStateMachine.OnElementContext c)` + Called every time an element is incorporated into a window. +
`void`	`onFire(TriggerStateMachine.TriggerContext context)` + Adjusts the state of the trigger to be ready for the next pane. +
`void`	`onMerge(TriggerStateMachine.OnMergeContext c)` + Called immediately after windows have been merged. +
`boolean`	`shouldFire(TriggerStateMachine.TriggerContext context)` + Returns `true` if the current state of the trigger indicates that its condition + is satisfied and it is ready to fire. +
`String`	`toString()`

+ + +
Methods inherited from class org.apache.beam.runners.core.triggers.TriggerStateMachine
+clear, equals, hashCode, isCompatible, orFinally, prefetchOnElement, prefetchOnFire, prefetchOnMerge, prefetchShouldFire, subTriggers

+ + +
Methods inherited from class java.lang.Object
+clone, finalize, getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    ReshuffleTriggerStateMachine
    +
```
public ReshuffleTriggerStateMachine()
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    onElement
    +
```
public void onElement(TriggerStateMachine.OnElementContext c)
```
    +
    Description copied from class: TriggerStateMachine
    +
    Called every time an element is incorporated into a window.
    +
    +
    Specified by:
    +
    onElement in class TriggerStateMachine
    +
    +
  + + + +
  - +
    onMerge
    +
```
public void onMerge(TriggerStateMachine.OnMergeContext c)
```
    +
    Description copied from class: TriggerStateMachine
    +
    Called immediately after windows have been merged. + +
    Leaf triggers should update their state by inspecting their status and any state in the + merging windows. Composite triggers should update their state by calling ExecutableTriggerStateMachine.invokeOnMerge(org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext) on their sub-triggers, and applying appropriate + logic. + +
    A trigger such as AfterWatermarkStateMachine.pastEndOfWindow() may no longer be + finished; it is the responsibility of the trigger itself to record this fact. It is forbidden + for a trigger to become finished due to TriggerStateMachine.onMerge(org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext), as it has not yet fired the pending + elements that led to it being ready to fire. + +
    The implementation does not need to clear out any state associated with the old windows.
    +
    +
    Specified by:
    +
    onMerge in class TriggerStateMachine
    +
    +
  + + + +
  - +
    shouldFire
    +
```
public boolean shouldFire(TriggerStateMachine.TriggerContext context)
+                   throws Exception
```
    +
    Description copied from class: TriggerStateMachine
    +
    Returns true if the current state of the trigger indicates that its condition + is satisfied and it is ready to fire.
    +
    +
    Specified by:
    +
    shouldFire in class TriggerStateMachine
    +
    Throws:
    +
    Exception
    +
    +
  + + + +
  - +
    onFire
    +
```
public void onFire(TriggerStateMachine.TriggerContext context)
+            throws Exception
```
    +
    Description copied from class: TriggerStateMachine
    +
    Adjusts the state of the trigger to be ready for the next pane. For example, a + RepeatedlyStateMachine trigger will reset its inner trigger, since it has fired. + +
    If the trigger is finished, it is the responsibility of the trigger itself to + record that fact via the context.
    +
    +
    Specified by:
    +
    onFire in class TriggerStateMachine
    +
    Throws:
    +
    Exception
    +
    +
  + + + +
  - +
    toString
    +
```
public String toString()
```
    +
    +
    Overrides:
    +
    toString in class TriggerStateMachine
    +
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

+ + http://git-wip-us.apache.org/repos/asf/beam-site/blob/0c7c6b2a/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/TriggerStateMachine.MergingTriggerInfo.html ---------------------------------------------------------------------- diff --git a/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/TriggerStateMachine.MergingTriggerInfo.html b/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/TriggerStateMachine.MergingTriggerInfo.html new file mode 100644 index 0000000..a6019d2 --- /dev/null +++ b/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/TriggerStateMachine.MergingTriggerInfo.html @@ -0,0 +1,260 @@ + + + + + + +TriggerStateMachine.MergingTriggerInfo (Apache Beam SDK for Java, version 0.4.0) + + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

+
+
All Superinterfaces:
+
TriggerStateMachine.TriggerInfo
+
+
+
Enclosing class:
+
TriggerStateMachine
+
+
+
+
```
public static interface TriggerStateMachine.MergingTriggerInfo
+extends TriggerStateMachine.TriggerInfo
```
+
Interact with properties of the trigger being executed, with extensions to deal with the + merging windows.
+

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + +

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`finishedInAllMergingWindows()` + Return true if the trigger is finished in all windows being merged. +
`boolean`	`finishedInAnyMergingWindow()` + Return true if the trigger is finished in any window being merged. +

+ + +
Methods inherited from interface org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerInfo
+areAllSubtriggersFinished, firstUnfinishedSubTrigger, isFinished, isFinished, isMerging, resetTree, setFinished, setFinished, subTrigger, subTriggers, unfinishedSubTriggers

+ +
- + + +
  Method Detail
  + + + +
  - +
    finishedInAnyMergingWindow
    +
```
boolean finishedInAnyMergingWindow()
```
    +
    Return true if the trigger is finished in any window being merged.
    +
  + + + +
  - +
    finishedInAllMergingWindows
    +
```
boolean finishedInAllMergingWindows()
```
    +
    Return true if the trigger is finished in all windows being merged.
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

Class RepeatedlyStateMachine

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.beam.runners.core.triggers.TriggerStateMachine

Field Summary

Fields inherited from class org.apache.beam.runners.core.triggers.TriggerStateMachine

Method Summary

Methods inherited from class org.apache.beam.runners.core.triggers.TriggerStateMachine

Methods inherited from class java.lang.Object

Method Detail

forever

onElement

onMerge

shouldFire

onFire

toString

Class ReshuffleTriggerStateMachine

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.beam.runners.core.triggers.TriggerStateMachine

Field Summary

Fields inherited from class org.apache.beam.runners.core.triggers.TriggerStateMachine

Constructor Summary

Method Summary

Methods inherited from class org.apache.beam.runners.core.triggers.TriggerStateMachine

Methods inherited from class java.lang.Object

Constructor Detail

ReshuffleTriggerStateMachine

Method Detail

onElement

onMerge

shouldFire

onFire

toString

Interface TriggerStateMachine.MergingTriggerInfo

Method Summary

Methods inherited from interface org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerInfo

Method Detail

finishedInAnyMergingWindow

finishedInAllMergingWindows