Class: Google::Cloud::Bigtable::V2::ReadChangeStreamRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/bigtable/v2/bigtable.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#app_profile_id ⇒ ::String

Returns 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.



568
569
570
571
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 568

class ReadChangeStreamRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#continuation_tokens ⇒ ::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.



568
569
570
571
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 568

class ReadChangeStreamRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns 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.



568
569
570
571
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 568

class ReadChangeStreamRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#heartbeat_duration ⇒ ::Google::Protobuf::Duration

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

Returns:



568
569
570
571
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 568

class ReadChangeStreamRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#partition ⇒ ::Google::Cloud::Bigtable::V2::StreamPartition

Returns The partition to read changes from.

Returns:



568
569
570
571
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 568

class ReadChangeStreamRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns 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.



568
569
570
571
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 568

class ReadChangeStreamRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#table_name ⇒ ::String

Returns 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.



568
569
570
571
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 568

class ReadChangeStreamRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end