org.apache.beam.sdk.transforms

Class DoFn.ProcessContinuation

java.lang.Object

org.apache.beam.sdk.transforms.DoFn.ProcessContinuation

Enclosing class:

DoFn<InputT,OutputT>

@Experimental(value=SPLITTABLE_DO_FN)
public abstract static class DoFn.ProcessContinuation
extends java.lang.Object

When used as a return value of DoFn.ProcessElement, indicates whether there is more work to be done for the current element.

If the DoFn.ProcessElement call completes because of a failed tryClaim() call on the RestrictionTracker, then the call MUST return stop().

Constructor Summary

Constructors

Constructor and Description
ProcessContinuation()

Method Summary

Modifier and Type	Method and Description
static DoFn.ProcessContinuation	resume() Indicates that there is more work to be done for the current element.
abstract Duration	resumeDelay() A minimum duration that should elapse between the end of this DoFn.ProcessElement call and the DoFn.ProcessElement call continuing processing of the same element.
abstract boolean	shouldResume() If false, the DoFn promises that there is no more work remaining for the current element, so the runner should not resume the DoFn.ProcessElement call.
static DoFn.ProcessContinuation	stop() Indicates that there is no more work to be done for the current element.
DoFn.ProcessContinuation	withResumeDelay(Duration resumeDelay) Builder method to set the value of resumeDelay().

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessContinuation

public ProcessContinuation()

Method Detail

stop

public static DoFn.ProcessContinuation stop()

Indicates that there is no more work to be done for the current element.

resume

public static DoFn.ProcessContinuation resume()

Indicates that there is more work to be done for the current element.

shouldResume

public abstract boolean shouldResume()

If false, the DoFn promises that there is no more work remaining for the current element, so the runner should not resume the DoFn.ProcessElement call.

resumeDelay

public abstract Duration resumeDelay()

A minimum duration that should elapse between the end of this DoFn.ProcessElement call and the DoFn.ProcessElement call continuing processing of the same element. By default, zero.

withResumeDelay

public DoFn.ProcessContinuation withResumeDelay(Duration resumeDelay)

Builder method to set the value of resumeDelay().