edit-icon download-icon

ListStream

Last Updated: Mar 23, 2018

Action:

ListStream obtains information about the stream that is enabled for all tables on the current instance.

Request structure:

  1. message ListStreamRequest {
  2. optional string table_name = 1;
  3. }

table_name:

  • Type: optional string

  • The name of the table for which the current stream is enabled.

Response message structure:

  1. message ListStreamResponse {
  2. repeated Stream streams = 1;
  3. }
  4. message Stream {
  5. required string stream_id = 1;
  6. required string table_name = 2;
  7. required int64 creation_time = 3;
  8. }

stream_id:

  • Type: required string

  • The ID of the current stream.

table_name:

  • Type: required string

  • The name of the table for which the current stream is enabled.

creation_time:

  • Type: required int64

  • The time when the current stream is enabled.

Thank you! We've received your feedback.