Interface ChangeStreamRecordAdapter<ChangeStreamRecordT> (2.37.0)

public interface ChangeStreamRecordAdapter<ChangeStreamRecordT>

An extension point that allows end users to plug in a custom implementation of logical change stream records. This is useful in cases where the user would like to apply advanced client side filtering(for example, only keep DeleteFamily in the mutations). This adapter acts like a factory for a SAX style change stream record builder.

Type Parameter
Name	Description
`ChangeStreamRecordT`

Methods

createChangeStreamRecordBuilder()

public abstract ChangeStreamRecordAdapter.ChangeStreamRecordBuilder<ChangeStreamRecordT> createChangeStreamRecordBuilder()

Creates a new instance of a ChangeStreamRecordBuilder.

Returns
Type	Description
`ChangeStreamRecordBuilder<ChangeStreamRecordT>`

getTokenFromChangeStreamMutation(ChangeStreamRecordT record)

public abstract String getTokenFromChangeStreamMutation(ChangeStreamRecordT record)

Get the token from the given ChangeStreamMutation record. If the given record is not a ChangeStreamMutation, it will throw an Exception.

Parameter
Name	Description
`record`	`ChangeStreamRecordT`

Returns
Type	Description
`String`

getTokenFromHeartbeat(ChangeStreamRecordT heartbeatRecord)

public abstract String getTokenFromHeartbeat(ChangeStreamRecordT heartbeatRecord)

Get the token from the given Heartbeat record. If the given record is not a Heartbeat, it will throw an Exception.

Parameter
Name	Description
`heartbeatRecord`	`ChangeStreamRecordT`

Returns
Type	Description
`String`

isChangeStreamMutation(ChangeStreamRecordT record)

public abstract boolean isChangeStreamMutation(ChangeStreamRecordT record)

Checks if the given change stream record is a ChangeStreamMutation.

Parameter
Name	Description
`record`	`ChangeStreamRecordT`

Returns
Type	Description
`boolean`

isHeartbeat(ChangeStreamRecordT record)

public abstract boolean isHeartbeat(ChangeStreamRecordT record)

Checks if the given change stream record is a Heartbeat.

Parameter
Name	Description
`record`	`ChangeStreamRecordT`

Returns
Type	Description
`boolean`