Package org.apache.beam.sdk.io.gcp.bigtable.changestreams.restriction

Class StreamProgress

java.lang.Object

org.apache.beam.sdk.io.gcp.bigtable.changestreams.restriction.StreamProgress

All Implemented Interfaces:

Serializable

@Internal
public class StreamProgress
extends Object
implements Serializable

Position for ReadChangeStreamPartitionProgressTracker. This represents contains information that allows a stream, along with the PartitionRecord to resume from a checkpoint.

It should contain either a continuation token which represents a position in the stream, or it can contain a close stream message which represents an end to the stream and the DoFn needs to stop.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
StreamProgress()
StreamProgress(@Nullable ChangeStreamContinuationToken token, Instant estimatedLowWatermark, BigDecimal throughputEstimate, Instant lastRunTimestamp, boolean isHeartbeat)
StreamProgress(@Nullable CloseStream closeStream)

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
@Nullable CloseStream	getCloseStream()
@Nullable ChangeStreamContinuationToken	getCurrentToken()
@Nullable Instant	getEstimatedLowWatermark()
@Nullable Instant	getLastRunTimestamp()
@Nullable BigDecimal	getThroughputEstimate()
int	hashCode()
boolean	isEmpty()
boolean	isFailToLock()
boolean	isHeartbeat()
void	setFailToLock(boolean failToLock)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StreamProgress

public StreamProgress()

StreamProgress

public StreamProgress(@Nullable ChangeStreamContinuationToken token,
 Instant estimatedLowWatermark,
 BigDecimal throughputEstimate,
 Instant lastRunTimestamp,
 boolean isHeartbeat)

StreamProgress

public StreamProgress(@Nullable CloseStream closeStream)

Method Details

getCurrentToken

public @Nullable ChangeStreamContinuationToken getCurrentToken()

getEstimatedLowWatermark

public @Nullable Instant getEstimatedLowWatermark()

getThroughputEstimate

public @Nullable BigDecimal getThroughputEstimate()

getLastRunTimestamp

public @Nullable Instant getLastRunTimestamp()

getCloseStream

public @Nullable CloseStream getCloseStream()

isFailToLock

public boolean isFailToLock()

setFailToLock

public void setFailToLock(boolean failToLock)

isHeartbeat

public boolean isHeartbeat()

isEmpty

public boolean isEmpty()

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object