Package org.apache.beam.sdk.io.gcp.spanner.changestreams.action

Class ActionFactory

java.lang.Object

org.apache.beam.sdk.io.gcp.spanner.changestreams.action.ActionFactory

All Implemented Interfaces:

Serializable

public class ActionFactory
extends Object
implements Serializable

Factory class for creating instances that will handle each type of record within a change stream query. The instances created are all singletons.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ActionFactory()

Method Summary

Modifier and Type	Method	Description
ChildPartitionsRecordAction	childPartitionsRecordAction(PartitionMetadataDao partitionMetadataDao, ChangeStreamMetrics metrics)	Creates and returns a singleton instance of an action class capable of process ChildPartitionsRecords.
DataChangeRecordAction	dataChangeRecordAction(ThroughputEstimator<DataChangeRecord> throughputEstimator)	Creates and returns a singleton instance of an action class capable of processing DataChangeRecords.
DetectNewPartitionsAction	detectNewPartitionsAction(PartitionMetadataDao partitionMetadataDao, PartitionMetadataMapper partitionMetadataMapper, WatermarkCache watermarkCache, ChangeStreamMetrics metrics, Duration resumeDuration)	Creates and returns a single instance of an action class capable of detecting and scheduling new partitions to be queried.
HeartbeatRecordAction	heartbeatRecordAction(ChangeStreamMetrics metrics, boolean cancelQueryOnHeartbeat)	Creates and returns a singleton instance of an action class capable of processing HeartbeatRecords.
PartitionEndRecordAction	partitionEndRecordAction(PartitionMetadataDao partitionMetadataDao, ChangeStreamMetrics metrics)	Creates and returns a singleton instance of an action class capable of process PartitionEndRecords.
PartitionEventRecordAction	partitionEventRecordAction(PartitionMetadataDao partitionMetadataDao, ChangeStreamMetrics metrics)	Creates and returns a singleton instance of an action class capable of process PartitionEventRecords.
PartitionStartRecordAction	partitionStartRecordAction(PartitionMetadataDao partitionMetadataDao, ChangeStreamMetrics metrics)	Creates and returns a singleton instance of an action class capable of process PartitionStartRecords.
QueryChangeStreamAction	queryChangeStreamAction(ChangeStreamDao changeStreamDao, PartitionMetadataDao partitionMetadataDao, ChangeStreamRecordMapper changeStreamRecordMapper, PartitionMetadataMapper partitionMetadataMapper, DataChangeRecordAction dataChangeRecordAction, HeartbeatRecordAction heartbeatRecordAction, ChildPartitionsRecordAction childPartitionsRecordAction, PartitionStartRecordAction partitionStartRecordAction, PartitionEndRecordAction partitionEndRecordAction, PartitionEventRecordAction partitionEventRecordAction, ChangeStreamMetrics metrics, boolean isMutableChangeStream, Duration realTimeCheckpointInterval)	Creates and returns a single instance of an action class capable of performing a change stream query for a given partition.

Methods inherited from class java.lang.Object

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

Constructor Details

ActionFactory

public ActionFactory()

Method Details

dataChangeRecordAction

public DataChangeRecordAction dataChangeRecordAction(ThroughputEstimator<DataChangeRecord> throughputEstimator)

Creates and returns a singleton instance of an action class capable of processing DataChangeRecords.

This method is thread safe.

Returns:

singleton instance of the DataChangeRecordAction

heartbeatRecordAction

public HeartbeatRecordAction heartbeatRecordAction(ChangeStreamMetrics metrics,
 boolean cancelQueryOnHeartbeat)

Creates and returns a singleton instance of an action class capable of processing HeartbeatRecords. This method is thread safe.

Parameters:

metrics - metrics gathering class

Returns:

singleton instance of the HeartbeatRecordAction

childPartitionsRecordAction

public ChildPartitionsRecordAction childPartitionsRecordAction(PartitionMetadataDao partitionMetadataDao,
 ChangeStreamMetrics metrics)

Creates and returns a singleton instance of an action class capable of process ChildPartitionsRecords. This method is thread safe.

Parameters:

partitionMetadataDao - DAO class to access the Connector's metadata tables

metrics - metrics gathering class

Returns:

singleton instance of the ChildPartitionsRecordAction

partitionStartRecordAction

public PartitionStartRecordAction partitionStartRecordAction(PartitionMetadataDao partitionMetadataDao,
 ChangeStreamMetrics metrics)

Creates and returns a singleton instance of an action class capable of process PartitionStartRecords. This method is thread safe.

Parameters:

partitionMetadataDao - DAO class to access the Connector's metadata tables

metrics - metrics gathering class

Returns:

singleton instance of the PartitionStartRecordAction

partitionEndRecordAction

public PartitionEndRecordAction partitionEndRecordAction(PartitionMetadataDao partitionMetadataDao,
 ChangeStreamMetrics metrics)

Creates and returns a singleton instance of an action class capable of process PartitionEndRecords. This method is thread safe.

Parameters:

partitionMetadataDao - DAO class to access the Connector's metadata tables

metrics - metrics gathering class

Returns:

singleton instance of the PartitionEndRecordAction

partitionEventRecordAction

public PartitionEventRecordAction partitionEventRecordAction(PartitionMetadataDao partitionMetadataDao,
 ChangeStreamMetrics metrics)

Creates and returns a singleton instance of an action class capable of process PartitionEventRecords. This method is thread safe.

Parameters:

partitionMetadataDao - DAO class to access the Connector's metadata tables

metrics - metrics gathering class

Returns:

singleton instance of the PartitionEventRecordAction

queryChangeStreamAction

public QueryChangeStreamAction queryChangeStreamAction(ChangeStreamDao changeStreamDao,
 PartitionMetadataDao partitionMetadataDao,
 ChangeStreamRecordMapper changeStreamRecordMapper,
 PartitionMetadataMapper partitionMetadataMapper,
 DataChangeRecordAction dataChangeRecordAction,
 HeartbeatRecordAction heartbeatRecordAction,
 ChildPartitionsRecordAction childPartitionsRecordAction,
 PartitionStartRecordAction partitionStartRecordAction,
 PartitionEndRecordAction partitionEndRecordAction,
 PartitionEventRecordAction partitionEventRecordAction,
 ChangeStreamMetrics metrics,
 boolean isMutableChangeStream,
 Duration realTimeCheckpointInterval)

Creates and returns a single instance of an action class capable of performing a change stream query for a given partition. It uses the DataChangeRecordAction, HeartbeatRecordAction, ChildPartitionsRecordAction, PartitionStartRecordAction ,PartitionEndRecordAction and PartitionEventRecordAction to dispatch the necessary processing depending on the type of record received.

Parameters:

changeStreamDao - DAO class to perform a change stream query

partitionMetadataDao - DAO class to access the Connector's metadata tables

changeStreamRecordMapper - mapper class to transform change stream records into the Connector's domain models

partitionMetadataMapper - mapper class to transform partition metadata rows into the Connector's domain models

dataChangeRecordAction - action class to process DataChangeRecords

heartbeatRecordAction - action class to process HeartbeatRecords

childPartitionsRecordAction - action class to process ChildPartitionsRecords

partitionStartRecordAction - action class to process PartitionStartRecords

partitionEndRecordAction - action class to process PartitionEndRecords

partitionEventRecordAction - action class to process PartitionEventRecords

metrics - metrics gathering class

realTimeCheckpointInterval - the duration added to current time for the end timestamp

Returns:

single instance of the QueryChangeStreamAction

detectNewPartitionsAction

public DetectNewPartitionsAction detectNewPartitionsAction(PartitionMetadataDao partitionMetadataDao,
 PartitionMetadataMapper partitionMetadataMapper,
 WatermarkCache watermarkCache,
 ChangeStreamMetrics metrics,
 Duration resumeDuration)

Creates and returns a single instance of an action class capable of detecting and scheduling new partitions to be queried.

Parameters:

partitionMetadataDao - DAO class to access the Connector's metadata tables

partitionMetadataMapper - mapper class to transform partition metadata table rows into the Connector's domain models

metrics - metrics gathering class

resumeDuration - specifies the periodic schedule to re-execute the action

Returns:

single instance of the DetectNewPartitionsAction