InProcessTimerInternals (Apache Beam SDK for Java 0.1.0-incubating API)

java.lang.Object
-
- org.apache.beam.runners.direct.InProcessTimerInternals
-

-
-
All Implemented Interfaces:
-
TimerInternals
-
-
-
-
```
public class InProcessTimerInternals
-extends Object
-implements TimerInternals
```
-
An implementation of TimerInternals where all relevant data exists in memory.
-

- -

- - -
Nested Class Summary
-
- - - -
  Nested classes/interfaces inherited from interface org.apache.beam.sdk.util.TimerInternals
  -TimerInternals.TimerData, TimerInternals.TimerDataCoder
-

- -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static InProcessTimerInternals`	`create(Clock clock, - InMemoryWatermarkManager.TransformWatermarks watermarks, - InMemoryWatermarkManager.TimerUpdate.TimerUpdateBuilder timerUpdateBuilder)`
`org.joda.time.Instant`	`currentInputWatermarkTime()` - Return the current, local input watermark timestamp for this computation - in the `TimeDomain.EVENT_TIME` time domain. -
`org.joda.time.Instant`	`currentOutputWatermarkTime()` - Return the current, local output watermark timestamp for this computation - in the `TimeDomain.EVENT_TIME` time domain. -
`org.joda.time.Instant`	`currentProcessingTime()` - Returns the current timestamp in the `TimeDomain.PROCESSING_TIME` time domain. -
`org.joda.time.Instant`	`currentSynchronizedProcessingTime()` - Returns the current timestamp in the `TimeDomain.SYNCHRONIZED_PROCESSING_TIME` time - domain or `null` if unknown. -
`void`	`deleteTimer(TimerInternals.TimerData timerKey)` - Deletes the given timer. -
`InMemoryWatermarkManager.TimerUpdate`	`getTimerUpdate()`
`void`	`setTimer(TimerInternals.TimerData timerKey)` - Writes out a timer to be fired when the watermark reaches the given - timestamp. -

- - -
Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- -
- - - -
  Method Detail
  - - - -
  - -
    create
    -
```
public static InProcessTimerInternals create(Clock clock,
-                                             InMemoryWatermarkManager.TransformWatermarks watermarks,
-                                             InMemoryWatermarkManager.TimerUpdate.TimerUpdateBuilder timerUpdateBuilder)
```
    -
  - - - -
  - -
    setTimer
    -
```
public void setTimer(TimerInternals.TimerData timerKey)
```
    -
    Description copied from interface: TimerInternals
    -
    Writes out a timer to be fired when the watermark reaches the given - timestamp. - -
    The combination of namespace, timestamp and domain uniquely - identify a timer. Multiple timers set for the same parameters can be safely deduplicated.
    -
    -
    Specified by:
    -
    setTimer in interface TimerInternals
    -
    -
  - - - -
  - -
    deleteTimer
    -
```
public void deleteTimer(TimerInternals.TimerData timerKey)
```
    -
    Description copied from interface: TimerInternals
    -
    Deletes the given timer.
    -
    -
    Specified by:
    -
    deleteTimer in interface TimerInternals
    -
    -
  - - - -
  - -
    getTimerUpdate
    -
```
public InMemoryWatermarkManager.TimerUpdate getTimerUpdate()
```
    -
  - - - -
  - -
    currentProcessingTime
    -
```
public org.joda.time.Instant currentProcessingTime()
```
    -
    Description copied from interface: TimerInternals
    -
    Returns the current timestamp in the TimeDomain.PROCESSING_TIME time domain.
    -
    -
    Specified by:
    -
    currentProcessingTime in interface TimerInternals
    -
    -
  - - - -
  - -
    currentSynchronizedProcessingTime
    -
```
@Nullable
-public org.joda.time.Instant currentSynchronizedProcessingTime()
```
    -
    Description copied from interface: TimerInternals
    -
    Returns the current timestamp in the TimeDomain.SYNCHRONIZED_PROCESSING_TIME time - domain or null if unknown.
    -
    -
    Specified by:
    -
    currentSynchronizedProcessingTime in interface TimerInternals
    -
    -
  - - - -
  - -
    currentInputWatermarkTime
    -
```
public org.joda.time.Instant currentInputWatermarkTime()
```
    -
    Description copied from interface: TimerInternals
    -
    Return the current, local input watermark timestamp for this computation - in the TimeDomain.EVENT_TIME time domain. - -
    This value: -
    1. Is never null, but may be BoundedWindow.TIMESTAMP_MIN_VALUE. -
    2. Is monotonically increasing. -
    3. May differ between workers due to network and other delays. -
    4. Will never be ahead of the global input watermark for this computation. But it - may be arbitrarily behind the global input watermark. -
    5. Any element with a timestamp before the local input watermark can be considered - 'locally late' and be subject to special processing or be dropped entirely. -
    - -
    Note that because the local input watermark can be behind the global input watermark, - it is possible for an element to be considered locally on-time even though it is - globally late.
    -
    -
    Specified by:
    -
    currentInputWatermarkTime in interface TimerInternals
    -
    -
  - - - -
  - -
    currentOutputWatermarkTime
    -
```
@Nullable
-public org.joda.time.Instant currentOutputWatermarkTime()
```
    -
    Description copied from interface: TimerInternals
    -
    Return the current, local output watermark timestamp for this computation - in the TimeDomain.EVENT_TIME time domain. Return null if unknown. - -
    This value: -
    1. Is monotonically increasing. -
    2. Will never be ahead of TimerInternals.currentInputWatermarkTime() as returned above. -
    3. May differ between workers due to network and other delays. -
    4. However will never be behind the global input watermark for any following computation. -
    - -
    In pictures: -
```
-  |              |       |       |       |
-  |              |   D   |   C   |   B   |   A
-  |              |       |       |       |
- GIWM     <=    GOWM <= LOWM <= LIWM <= GIWM
- (next stage)
- -------------------------------------------------> event time
- 
```
    - where -
    - LOWM = local output water mark. -
    - GOWM = global output water mark. -
    - GIWM = global input water mark. -
    - LIWM = local input water mark. -
    - A = A globally on-time element. -
    - B = A globally late, but locally on-time element. -
    - C = A locally late element which may still contribute to the timestamp of a pane. -
    - D = A locally late element which cannot contribute to the timestamp of a pane. -
    - -
    Note that if a computation emits an element which is not before the current output watermark - then that element will always appear locally on-time in all following computations. However, - it is possible for an element emitted before the current output watermark to appear locally - on-time in a following computation. Thus we must be careful to never assume locally late data - viewed on the output of a computation remains locally late on the input of a following - computation.
    -
    -
    Specified by:
    -
    currentOutputWatermarkTime in interface TimerInternals
    -
    -
  -
-

-
-
All Known Implementing Classes:
-
StepTransformResult
-
-
-
-
```
public interface InProcessTransformResult
```
-
The result of evaluating an AppliedPTransform with a TransformEvaluator.
-

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CounterSet`	`getCounters()` - Returns the `CounterSet` used by this `PTransform`, or null if this transform did - not use a `CounterSet`. -
`Iterable<? extends InProcessPipelineRunner.UncommittedBundle<?>>`	`getOutputBundles()` - Returns the `(uncommitted) Bundles` output by this transform. -
`CopyOnAccessInMemoryStateInternals<?>`	`getState()` - Returns the State used by the transform. -
`InMemoryWatermarkManager.TimerUpdate`	`getTimerUpdate()` - Returns a TimerUpdateBuilder that was produced as a result of this evaluation. -
`AppliedPTransform<?,?,?>`	`getTransform()` - Returns the `AppliedPTransform` that produced this result. -
`Iterable<? extends WindowedValue<?>>`	`getUnprocessedElements()` - Returns elements that were provided to the `TransformEvaluator` as input but were not - processed. -
`org.joda.time.Instant`	`getWatermarkHold()` - Returns the Watermark Hold for the transform at the time this result was produced. -

- -
- - - -
  Method Detail
  - - - -
  - -
    getTransform
    -
```
AppliedPTransform<?,?,?> getTransform()
```
    -
    Returns the AppliedPTransform that produced this result.
    -
  - - - -
  - -
    getOutputBundles
    -
```
Iterable<? extends InProcessPipelineRunner.UncommittedBundle<?>> getOutputBundles()
```
    -
    Returns the (uncommitted) Bundles output by this transform. These - will be committed by the evaluation context as part of completing this result.
    -
  - - - -
  - -
    getUnprocessedElements
    -
```
Iterable<? extends WindowedValue<?>> getUnprocessedElements()
```
    -
    Returns elements that were provided to the TransformEvaluator as input but were not - processed.
    -
  - - - -
  - -
    getCounters
    -
```
@Nullable
-CounterSet getCounters()
```
    -
    Returns the CounterSet used by this PTransform, or null if this transform did - not use a CounterSet.
    -
  - - - -
  - -
    getWatermarkHold
    -
```
org.joda.time.Instant getWatermarkHold()
```
    -
    Returns the Watermark Hold for the transform at the time this result was produced. - - If the transform does not set any watermark hold, returns - BoundedWindow.TIMESTAMP_MAX_VALUE.
    -
  - - - -
  - -
    getState
    -
```
@Nullable
-CopyOnAccessInMemoryStateInternals<?> getState()
```
    -
    Returns the State used by the transform. - - If this evaluation did not access state, this may return null.
    -
  - - - -
  - -
    getTimerUpdate
    -
```
InMemoryWatermarkManager.TimerUpdate getTimerUpdate()
```
    -
    Returns a TimerUpdateBuilder that was produced as a result of this evaluation. If the - evaluation was triggered due to the delivery of one or more timers, those timers must be added - to the builder before it is complete. - -
    If this evaluation did not add or remove any timers, returns an empty TimerUpdate.
    -
  -
-

-
-
-
```
public interface ModelEnforcement<T>
```
-
Enforcement tools that verify that executing code conforms to the model. - -
ModelEnforcement is performed on a per-element and per-bundle basis. The - ModelEnforcement is provided with the input bundle as part of - ModelEnforcementFactory#forBundle(CommittedBundle, AppliedPTransform), each element - before and after that element is provided to an underlying TransformEvaluator, and the - output InProcessTransformResult and committed output bundles after the - TransformEvaluator has completed. - -
Typically, ModelEnforcement will obtain required metadata (such as the Coder - of the input PCollection on construction, and then enforce per-element behavior - (such as the immutability of input elements). When the element is output or the bundle is - completed, the required conditions can be enforced across all elements.
-

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - -

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`afterElement(WindowedValue<T> element)` - Called after a call to `TransformEvaluator.processElement(WindowedValue)` on the - provided `WindowedValue`. -
`void`	`afterFinish(InProcessPipelineRunner.CommittedBundle<T> input, - InProcessTransformResult result, - Iterable<? extends InProcessPipelineRunner.CommittedBundle<?>> outputs)` - Called after a bundle has been completed and `TransformEvaluator.finishBundle()` has been - called, producing the provided `InProcessTransformResult` and - `output bundles`. -
`void`	`beforeElement(WindowedValue<T> element)` - Called before a call to `TransformEvaluator.processElement(WindowedValue)` on the - provided `WindowedValue`. -

- -
- - - -
  Method Detail
  - - - -
  - -
    beforeElement
    -
```
void beforeElement(WindowedValue<T> element)
```
    -
    Called before a call to TransformEvaluator.processElement(WindowedValue) on the - provided WindowedValue.
    -
  - - - -
  - -
    afterElement
    -
```
void afterElement(WindowedValue<T> element)
```
    -
    Called after a call to TransformEvaluator.processElement(WindowedValue) on the - provided WindowedValue.
    -
  - - - -
  - -
    afterFinish
    -
```
void afterFinish(InProcessPipelineRunner.CommittedBundle<T> input,
-                 InProcessTransformResult result,
-                 Iterable<? extends InProcessPipelineRunner.CommittedBundle<?>> outputs)
```
    -
    Called after a bundle has been completed and TransformEvaluator.finishBundle() has been - called, producing the provided InProcessTransformResult and - output bundles.
    -
  -
-

Class InProcessTimerInternals

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.sdk.util.TimerInternals

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

setTimer

deleteTimer

getTimerUpdate

currentProcessingTime

currentSynchronizedProcessingTime

currentInputWatermarkTime

currentOutputWatermarkTime

Interface InProcessTransformResult

Method Summary

Method Detail

getTransform

getOutputBundles

getUnprocessedElements

getCounters

getWatermarkHold

getState

getTimerUpdate

Interface ModelEnforcement<T>

Method Summary

Method Detail

beforeElement

afterElement

afterFinish

Interface ModelEnforcementFactory

Method Summary

Method Detail

forBundle