Cloud Bigtable V2 API - Class Google::Cloud::Bigtable::V2::ReadChangeStreamRequest (v1.1.0)

Reference documentation and code samples for the Cloud Bigtable V2 API class Google::Cloud::Bigtable::V2::ReadChangeStreamRequest.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#app_profile_id

def app_profile_id() -> ::String
Returns
  • (::String) — 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.

#app_profile_id=

def app_profile_id=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#continuation_tokens

def continuation_tokens() -> ::Google::Cloud::Bigtable::V2::StreamContinuationTokens
Returns
  • (::Google::Cloud::Bigtable::V2::StreamContinuationTokens) — 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.

#continuation_tokens=

def continuation_tokens=(value) -> ::Google::Cloud::Bigtable::V2::StreamContinuationTokens
Parameter
  • value (::Google::Cloud::Bigtable::V2::StreamContinuationTokens) — 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.

Returns
  • (::Google::Cloud::Bigtable::V2::StreamContinuationTokens) — 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.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — 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.

#end_time=

def end_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — 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.
Returns
  • (::Google::Protobuf::Timestamp) — 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.

#heartbeat_duration

def heartbeat_duration() -> ::Google::Protobuf::Duration
Returns

#heartbeat_duration=

def heartbeat_duration=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — If specified, the duration between Heartbeat messages on the stream. Otherwise, defaults to 5 seconds.
Returns

#partition

def partition() -> ::Google::Cloud::Bigtable::V2::StreamPartition
Returns

#partition=

def partition=(value) -> ::Google::Cloud::Bigtable::V2::StreamPartition
Parameter
Returns

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — 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.

#start_time=

def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — 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.
Returns
  • (::Google::Protobuf::Timestamp) — 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.

#table_name

def table_name() -> ::String
Returns
  • (::String) — 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.

#table_name=

def table_name=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.