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

Class ChangeStreamResultSetMetadata

java.lang.Object
org.apache.beam.sdk.io.gcp.spanner.changestreams.dao.ChangeStreamResultSetMetadata
public class ChangeStreamResultSetMetadata extends Object
Represents telemetry metadata gathered during the consumption of a change stream query. Within this class the caller will be able to retrieve the following information:
  • The timestamp at which the query first started.
  • The timestamp at which a record streaming started.
  • The timestamp at which a record streaming ended.
  • The timestamp at which a record was read by the caller.
  • The total time for streaming all records within the query.
  • The total number of records streamed within the query.

  • Method Details

    • getQueryStartedAt

      public com.google.cloud.Timestamp getQueryStartedAt()
      Returns the timestamp at which the change stream query for a ChangeStreamResultSet first started.

    • getRecordStreamStartedAt

      public com.google.cloud.Timestamp getRecordStreamStartedAt()
      Returns the timestamp at which a record first started to be streamed.

    • getRecordStreamEndedAt

      public com.google.cloud.Timestamp getRecordStreamEndedAt()
      Returns the timestamp at which a record finished to be streamed.

    • getRecordReadAt

      public com.google.cloud.Timestamp getRecordReadAt()
      Returns the timestamp at which a record was read from the ChangeStreamResultSet.

    • getTotalStreamDuration

      public Duration getTotalStreamDuration()
      Returns the total stream duration of change stream records so far.

    • getNumberOfRecordsRead

      public long getNumberOfRecordsRead()
      Returns the total number of records read from the change stream so far.