edit-icon download-icon

DescribeStream

最終更新日: Apr 17, 2018

アクション:

現在のストリームのシャードに関する情報を取得します。

注意: 親シャードのデータの読み取りは、現在のシャードのデータを読み取る前に完了する必要があります。

リクエストの構造:

  1. message DescribeStreamRequest {
  2. required string stream_id = 1;
  3. optional string inclusive_start_shard_id = 2;
  4. optional int32 shard_limit = 3;
  5. }

stream_id:

  • 型: required string

  • 現在のストリームの ID

inclusive_start_shard_id:

  • 型: required string

  • クエリで開始するシャードの ID

shard_limit:

  • 型: required string

  • 単一クエリで返されるシャード数の上限

応答メッセージの構造:

  1. message DescribeStreamResponse {
  2. required string stream_id = 1;
  3. required int32 expiration_time = 2;
  4. required string table_name = 3;
  5. required int64 creation_time = 4;
  6. required StreamStatus stream_status = 5;
  7. repeated StreamShard shards = 6;
  8. optional string next_shard_id = 7;
  9. }
  10. message StreamShard {
  11. required string shard_id = 1;
  12. optional string parent_id = 2;
  13. optional string parent_sibling_id = 3;
  14. }

stream_id:

  • 型: required string

  • 現在のストリームの ID

expiration_time:

  • 型: required int32

  • ストリームの有効期限

table_name:

  • 型: required string

  • 現在のストリームが属するテーブルの名前

creation_time:

  • 型: required int32

  • 現在のストリームの作成時刻

stream_status:

  • 型: required StreamStatus

  • 現在のストリームのステータス (有効またはアクティブ)

shards:

  • 型: required StreamShard

  • streamShard に関する情報 (シャード ID、親シャード ID を含む) と親シャードの隣接シャードに関する情報 (親シャード結合時)

next_shard_id:

  • 型: optional string

  • ページングクエリでの次のシャードの ID