ChangeStreamRecordMetadata (Apache Beam 2.59.0)

java.lang.Object
- org.apache.beam.sdk.io.gcp.spanner.changestreams.model.ChangeStreamRecordMetadata

All Implemented Interfaces:

java.io.Serializable
```
@DefaultCoder(value=AvroCoder.class)
public class ChangeStreamRecordMetadata
extends java.lang.Object
implements java.io.Serializable
```
Holds internal execution metrics / metadata for the processed ChangeStreamRecord.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ChangeStreamRecordMetadata.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChangeStreamRecordMetadata.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`long`	`getNumberOfRecordsRead()` The number of records read in the partition change stream query before reading this record.
`com.google.cloud.Timestamp`	`getPartitionCreatedAt()` The time at which this partition was first detected and created in the metadata table.
`com.google.cloud.Timestamp`	`getPartitionEndTimestamp()` The end time for the partition change stream query, which produced this record.
`com.google.cloud.Timestamp`	`getPartitionRunningAt()` The time at which the connector started processing this partition.
`com.google.cloud.Timestamp`	`getPartitionScheduledAt()` The time at which this partition was scheduled to be queried.
`com.google.cloud.Timestamp`	`getPartitionStartTimestamp()` The start time for the partition change stream query, which produced this record.
`java.lang.String`	`getPartitionToken()` The partition token that produced this change stream record.
`com.google.cloud.Timestamp`	`getQueryStartedAt()` The time that the change stream query which produced this record started.
`com.google.cloud.Timestamp`	`getRecordReadAt()` The time at which the record was fully read.
`com.google.cloud.Timestamp`	`getRecordStreamEndedAt()` The time at which the record finished streaming.
`com.google.cloud.Timestamp`	`getRecordStreamStartedAt()` The time at which the record started to be streamed.
`com.google.cloud.Timestamp`	`getRecordTimestamp()` The Cloud Spanner timestamp time when this record occurred.
`long`	`getTotalStreamTimeMillis()` The total streaming time (in millis) for this record.
`int`	`hashCode()`
`static ChangeStreamRecordMetadata.Builder`	`newBuilder()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getPartitionToken
```
public java.lang.String getPartitionToken()
```
    The partition token that produced this change stream record.
  - getRecordTimestamp
```
public com.google.cloud.Timestamp getRecordTimestamp()
```
    The Cloud Spanner timestamp time when this record occurred.
  - getPartitionStartTimestamp
```
public com.google.cloud.Timestamp getPartitionStartTimestamp()
```
    The start time for the partition change stream query, which produced this record.
  - getPartitionEndTimestamp
```
public com.google.cloud.Timestamp getPartitionEndTimestamp()
```
    The end time for the partition change stream query, which produced this record.
  - getPartitionCreatedAt
```
public com.google.cloud.Timestamp getPartitionCreatedAt()
```
    The time at which this partition was first detected and created in the metadata table.
  - getPartitionScheduledAt
```
@Nullable
public com.google.cloud.Timestamp getPartitionScheduledAt()
```
    The time at which this partition was scheduled to be queried.
  - getPartitionRunningAt
```
@Nullable
public com.google.cloud.Timestamp getPartitionRunningAt()
```
    The time at which the connector started processing this partition.
  - getQueryStartedAt
```
public com.google.cloud.Timestamp getQueryStartedAt()
```
    The time that the change stream query which produced this record started.
  - getRecordStreamStartedAt
```
public com.google.cloud.Timestamp getRecordStreamStartedAt()
```
    The time at which the record started to be streamed.
  - getRecordStreamEndedAt
```
public com.google.cloud.Timestamp getRecordStreamEndedAt()
```
    The time at which the record finished streaming.
  - getRecordReadAt
```
public com.google.cloud.Timestamp getRecordReadAt()
```
    The time at which the record was fully read.
  - getTotalStreamTimeMillis
```
public long getTotalStreamTimeMillis()
```
    The total streaming time (in millis) for this record.
  - getNumberOfRecordsRead
```
public long getNumberOfRecordsRead()
```
    The number of records read in the partition change stream query before reading this record.
  - equals
```
public boolean equals(@Nullable
                      java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - newBuilder
```
public static ChangeStreamRecordMetadata.Builder newBuilder()
```

Class ChangeStreamRecordMetadata

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getPartitionToken

getRecordTimestamp

getPartitionStartTimestamp

getPartitionEndTimestamp

getPartitionCreatedAt

getPartitionScheduledAt

getPartitionRunningAt

getQueryStartedAt

getRecordStreamStartedAt

getRecordStreamEndedAt

getRecordReadAt

getTotalStreamTimeMillis

getNumberOfRecordsRead

equals

hashCode

toString

newBuilder