Package org.apache.beam.runners.fnexecution.control

Class SdkHarnessClient.BundleProcessor.ActiveBundle

java.lang.Object

org.apache.beam.runners.fnexecution.control.SdkHarnessClient.BundleProcessor.ActiveBundle

All Implemented Interfaces:

AutoCloseable, RemoteBundle

Enclosing class:

SdkHarnessClient.BundleProcessor

public class SdkHarnessClient.BundleProcessor.ActiveBundle
extends Object
implements RemoteBundle

An active bundle for a particular BeamFnApi.ProcessBundleDescriptor.

Method Summary

Modifier and Type	Method	Description
void	close()	Blocks until bundle processing is finished.
String	getId()	Returns an id used to represent this bundle.
Map<String,FnDataReceiver>	getInputReceivers()	Get a map of PCollection ids to receivers which consume input elements, forwarding them to the remote environment.
Map<KV<String,String>,FnDataReceiver<org.apache.beam.sdk.util.construction.Timer>>	getTimerReceivers()	Get a map of (transform id, timer id) to receivers which consume timers, forwarding them to the remote environment.
void	requestProgress()	Ask the remote bundle for progress.
void	split(double fractionOfRemainder)	Ask the remote bundle to split its current processing based upon its knowledge of remaining work.

Methods inherited from class java.lang.Object

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

Method Details

getId

public String getId()

Returns an id used to represent this bundle.

Specified by:

getId in interface RemoteBundle

getInputReceivers

public Map<String,FnDataReceiver> getInputReceivers()

Get a map of PCollection ids to receivers which consume input elements, forwarding them to the remote environment.

Specified by:

getInputReceivers in interface RemoteBundle

getTimerReceivers

public Map<KV<String,String>,FnDataReceiver<org.apache.beam.sdk.util.construction.Timer>> getTimerReceivers()

Description copied from interface: RemoteBundle

Get a map of (transform id, timer id) to receivers which consume timers, forwarding them to the remote environment.

Specified by:

getTimerReceivers in interface RemoteBundle

requestProgress

public void requestProgress()

Description copied from interface: RemoteBundle

Ask the remote bundle for progress.

This method is a no-op if the bundle is complete otherwise it will return after the request has been issued. Any progress reports will be forwarded to the BundleProgressHandler.

All BundleProgressHandler.onProgress(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleProgressResponse) calls are guaranteed to be called before any BundleProgressHandler.onCompleted(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleResponse).

Specified by:

requestProgress in interface RemoteBundle

split

public void split(double fractionOfRemainder)

Description copied from interface: RemoteBundle

Ask the remote bundle to split its current processing based upon its knowledge of remaining work. A fraction of 0, is equivalent to asking the SDK to checkpoint.

This method is a no-op if the bundle is complete otherwise it will return after the request has been issued. Any splits will be forwarded to the BundleSplitHandler.

All BundleSplitHandler.split(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleSplitResponse) calls are guaranteed to be called before any BundleCheckpointHandler.onCheckpoint(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleResponse).

Specified by:

split in interface RemoteBundle

close

public void close()
           throws Exception

Blocks until bundle processing is finished. This is comprised of:

• closing each input receiver.
• closing each timer receiver.
• waiting for the SDK to say that processing the bundle is finished.
• waiting for all inbound data clients to complete

This method will throw an exception if bundle processing has failed. Throwable.getSuppressed() will return all the reasons as to why processing has failed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface RemoteBundle

Throws:

Exception