Struct ReadChangeStreamRequest

pub struct ReadChangeStreamRequest {
    pub table_name: String,
    pub app_profile_id: String,
    pub partition: Option<StreamPartition>,
    pub end_time: Option<Timestamp>,
    pub heartbeat_duration: Option<Duration>,
    pub start_from: Option<StartFrom>,
}

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

Fields

table_name: 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.

app_profile_id: 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.

partition: Option<StreamPartition>

The partition to read changes from.

end_time: Option<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: Option<Duration>

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

start_from: Option<StartFrom>

Options for describing where we want to start reading from the stream.

Trait Implementations

impl Clone for ReadChangeStreamRequest

fn clone(&self) -> ReadChangeStreamRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReadChangeStreamRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ReadChangeStreamRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ReadChangeStreamRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ReadChangeStreamRequest

fn eq(&self, other: &ReadChangeStreamRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ReadChangeStreamRequest