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.
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.
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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-12 UTC."],[[["\u003cp\u003eThe latest version of the \u003ccode\u003eReadChangeStreamRequest\u003c/code\u003e class is 3.17.0, with documentation available for versions ranging back to 2.2.0.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eReadChangeStreamRequest\u003c/code\u003e is a class used within the Google Bigtable v2 API, specifically for managing requests to read a change stream, intended for use by Apache Beam BigtableIO.\u003c/p\u003e\n"],["\u003cp\u003eThis class allows specification of various parameters such as \u003ccode\u003eAppProfileId\u003c/code\u003e, \u003ccode\u003eContinuationTokens\u003c/code\u003e, \u003ccode\u003eEndTime\u003c/code\u003e, \u003ccode\u003eHeartbeatDuration\u003c/code\u003e, \u003ccode\u003ePartition\u003c/code\u003e, \u003ccode\u003eStartTime\u003c/code\u003e, and \u003ccode\u003eTableName\u003c/code\u003e for configuring the change stream read.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eReadChangeStreamRequest\u003c/code\u003e implements several interfaces including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, providing capabilities for message handling, equality comparison, deep cloning, and buffer management.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation provides constructor details, including a default constructor and a constructor that accepts another \u003ccode\u003eReadChangeStreamRequest\u003c/code\u003e object, as well as providing details about all properties it contains.\u003c/p\u003e\n"]]],[],null,["# Google Bigtable v2 API - Class ReadChangeStreamRequest (3.23.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.23.0 (latest)](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/latest/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.22.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.22.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.21.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.21.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.20.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.20.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.19.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.19.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.18.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.18.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.17.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.17.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.16.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.16.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.15.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.15.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.14.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.14.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.13.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.13.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.12.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.12.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.11.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.11.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.10.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.10.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.9.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.8.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.7.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.6.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.5.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.4.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.3.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.2.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.1.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/3.0.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/2.6.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/2.5.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/2.4.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/2.3.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/2.2.0/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest) \n\n public sealed class ReadChangeStreamRequest : IMessage\u003cReadChangeStreamRequest\u003e, IEquatable\u003cReadChangeStreamRequest\u003e, IDeepCloneable\u003cReadChangeStreamRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Google Bigtable v2 API class ReadChangeStreamRequest.\n\nNOTE: This API is intended to be used by Apache Beam BigtableIO.\nRequest message for Bigtable.ReadChangeStream. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ReadChangeStreamRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ReadChangeStreamRequest](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/latest/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ReadChangeStreamRequest](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/latest/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ReadChangeStreamRequest](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/latest/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Bigtable.V2](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/latest/Google.Cloud.Bigtable.V2)\n\nAssembly\n--------\n\nGoogle.Cloud.Bigtable.V2.dll\n\nConstructors\n------------\n\n### ReadChangeStreamRequest()\n\n public ReadChangeStreamRequest()\n\n### ReadChangeStreamRequest(ReadChangeStreamRequest)\n\n public ReadChangeStreamRequest(ReadChangeStreamRequest other)\n\nProperties\n----------\n\n### AppProfileId\n\n public string AppProfileId { get; set; }\n\nThis value specifies routing for replication. If not specified, the\n\"default\" application profile will be used.\nSingle cluster routing must be configured on the profile.\n\n### ContinuationTokens\n\n public StreamContinuationTokens ContinuationTokens { get; set; }\n\nTokens that describe how to resume reading a stream where reading\npreviously left off. If specified, changes will be read starting at the\nthe position. Tokens are delivered on the stream as part of `Heartbeat`\nand `CloseStream` messages.\n\nIf a single token is provided, the token's partition must exactly match\nthe request's partition. If multiple tokens are provided, as in the case\nof a partition merge, the union of the token partitions must exactly\ncover the request's partition. Otherwise, INVALID_ARGUMENT will be\nreturned.\n\n### EndTime\n\n public Timestamp EndTime { get; set; }\n\nIf specified, OK will be returned when the stream advances beyond\nthis time. Otherwise, changes will be continuously delivered on the stream.\nThis value is inclusive and will be truncated to microsecond granularity.\n\n### HeartbeatDuration\n\n public Duration HeartbeatDuration { get; set; }\n\nIf specified, the duration between `Heartbeat` messages on the stream.\nOtherwise, defaults to 5 seconds.\n\n### Partition\n\n public StreamPartition Partition { get; set; }\n\nThe partition to read changes from.\n\n### StartFromCase\n\n public ReadChangeStreamRequest.StartFromOneofCase StartFromCase { get; }\n\n### StartTime\n\n public Timestamp StartTime { get; set; }\n\nStart reading the stream at the specified timestamp. This timestamp must\nbe within the change stream retention period, less than or equal to the\ncurrent time, and after change stream creation, whichever is greater.\nThis value is inclusive and will be truncated to microsecond granularity.\n\n### TableName\n\n public string TableName { get; set; }\n\nRequired. The unique name of the table from which to read a change stream.\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e`.\nChange streaming must be enabled on the table.\n\n### TableNameAsTableName\n\n public TableName TableNameAsTableName { get; set; }\n\n[TableName](https://cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Common.V2/latest/Google.Cloud.Bigtable.Common.V2.TableName.html)-typed view over the [TableName](/dotnet/docs/reference/Google.Cloud.Bigtable.V2/latest/Google.Cloud.Bigtable.V2.ReadChangeStreamRequest#Google_Cloud_Bigtable_V2_ReadChangeStreamRequest_TableName) resource name property."]]
