Google Bigtable v2 API - Class ReadChangeStreamRequest (3.5.0)

public sealed class ReadChangeStreamRequest : IMessage<ReadChangeStreamRequest>, IEquatable<ReadChangeStreamRequest>, IDeepCloneable<ReadChangeStreamRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Bigtable v2 API class ReadChangeStreamRequest.

NOTE: This API is intended to be used by Apache Beam BigtableIO. Request message for Bigtable.ReadChangeStream.

Inheritance

object > ReadChangeStreamRequest

Implements

IMessage ReadChangeStreamRequest, IEquatable ReadChangeStreamRequest, IDeepCloneable ReadChangeStreamRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Constructors

ReadChangeStreamRequest()

public ReadChangeStreamRequest()

ReadChangeStreamRequest(ReadChangeStreamRequest)

public ReadChangeStreamRequest(ReadChangeStreamRequest other)

Parameter
Name	Description
`other`	`ReadChangeStreamRequest`

Properties

AppProfileId

public string AppProfileId { get; set; }

This value specifies routing for replication. If not specified, the "default" application profile will be used. Single cluster routing must be configured on the profile.

Property Value
Type	Description
`string`

ContinuationTokens

public StreamContinuationTokens ContinuationTokens { get; set; }

Tokens that describe how to resume reading a stream where reading previously left off. If specified, changes will be read starting at the the position. Tokens are delivered on the stream as part of Heartbeat and CloseStream messages.

If a single token is provided, the token’s partition must exactly match the request’s partition. If multiple tokens are provided, as in the case of a partition merge, the union of the token partitions must exactly cover the request’s partition. Otherwise, INVALID_ARGUMENT will be returned.

Property Value
Type	Description
`StreamContinuationTokens`

EndTime

public Timestamp EndTime { get; set; }

If specified, OK will be returned when the stream advances beyond this time. Otherwise, changes will be continuously delivered on the stream. This value is inclusive and will be truncated to microsecond granularity.

Property Value
Type	Description
`Timestamp`

HeartbeatDuration

public Duration HeartbeatDuration { get; set; }

If specified, the duration between Heartbeat messages on the stream. Otherwise, defaults to 5 seconds.

Property Value
Type	Description
`Duration`

Partition

public StreamPartition Partition { get; set; }

The partition to read changes from.

Property Value
Type	Description
`StreamPartition`

StartFromCase

public ReadChangeStreamRequest.StartFromOneofCase StartFromCase { get; }

Property Value
Type	Description
`ReadChangeStreamRequestStartFromOneofCase`

StartTime

public Timestamp StartTime { get; set; }

Start reading the stream at the specified timestamp. This timestamp must be within the change stream retention period, less than or equal to the current time, and after change stream creation, whichever is greater. This value is inclusive and will be truncated to microsecond granularity.

Property Value
Type	Description
`Timestamp`

TableName

public string TableName { get; set; }

Required. The unique name of the table from which to read a change stream. Values are of the form projects/<project>/instances/<instance>/tables/<table>. Change streaming must be enabled on the table.

Property Value
Type	Description
`string`

TableNameAsTableName

public TableName TableNameAsTableName { get; set; }

TableName-typed view over the TableName resource name property.

Property Value
Type	Description
`TableName`