Package org.apache.beam.sdk.transforms.splittabledofn

Class RestrictionTracker.Progress

java.lang.Object

org.apache.beam.sdk.transforms.splittabledofn.RestrictionTracker.Progress

Enclosing class:

RestrictionTracker<RestrictionT,PositionT>

public abstract static class RestrictionTracker.Progress
extends Object

A representation for the amount of known completed and remaining work. See RestrictionTracker.HasProgress.getProgress() for details.

Field Summary

Fields

Modifier and Type	Field	Description
static final RestrictionTracker.Progress	NONE	Constant Progress instance to be used when no work has been completed yet.

Constructor Summary

Constructors

Constructor	Description
Progress()

Method Summary

Modifier and Type	Method	Description
static RestrictionTracker.Progress	from(double workCompleted, double workRemaining)	A representation for the amount of known completed and remaining work.
abstract double	getWorkCompleted()	The known amount of completed work.
abstract double	getWorkRemaining()	The known amount of work remaining.

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static final RestrictionTracker.Progress NONE

Constant Progress instance to be used when no work has been completed yet.

Constructor Details

Progress

public Progress()

Method Details

from

public static RestrictionTracker.Progress from(double workCompleted,
 double workRemaining)

A representation for the amount of known completed and remaining work. See RestrictionTracker.HasProgress.getProgress() for details.

Parameters:

workCompleted - Must be >= 0.

workRemaining - Must be >= 0.

getWorkCompleted

public abstract double getWorkCompleted()

The known amount of completed work.

getWorkRemaining

public abstract double getWorkRemaining()

The known amount of work remaining.