トンネルの一覧表示 - Tablestore Java 用 SDK - Tablestore - Alibaba Cloud ドキュメントセンター

前提条件

Tablestore Java 用 SDK をインストールし、TunnelClient を初期化します。

機能の説明

listTunnel を呼び出して、テーブル内のすべてのトンネルを一覧表示します。レスポンスには、各トンネル内のチャネルに関する情報は含まれません。チャネル情報を取得するには、特定のトンネルの詳細をクエリします。

ListTunnelResponse listTunnel(ListTunnelRequest request)
        throws TableStoreException, ClientException

次の例では、example_table テーブル内のすべてのトンネルを一覧表示し、各トンネルの名前、タイプ、ステージ、作成時刻を出力します：

String tableName = "example_table";

ListTunnelRequest request = new ListTunnelRequest(tableName);
ListTunnelResponse response = tunnelClient.listTunnel(request);

for (TunnelInfo tunnelInfo : response.getTunnelInfos()) {
    System.out.printf(
            "name=%s, type=%s, stage=%s, createTime=%d%n",
            tunnelInfo.getTunnelName(),
            tunnelInfo.getTunnelType(),
            tunnelInfo.getStage(),
            tunnelInfo.getCreateTime());
}

パラメーター

request は ListTunnelRequest 型で、次のパラメーターが含まれます：

名前	タイプ	説明
tableName (必須)	`String`	テーブル名。

戻り値

戻り値は ListTunnelResponse 型で、次のフィールドが含まれます：

名前	タイプ	説明
tunnelInfos	`List<TunnelInfo>`	テーブル内のトンネルのリスト。`getTunnelInfos()` を呼び出してこのフィールドを取得します。

トンネル情報

tunnelInfos[] の各要素は TunnelInfo 型で、次のフィールドが含まれます：

名前	タイプ	説明
tunnelName	`String`	トンネル名。
tunnelId	`String`	トンネルの ID。
tunnelType	`TunnelType`	トンネルのタイプ。有効な値： `BaseData`、`Stream`、`BaseAndStream`。これらの値は、それぞれ全量データのみ、増分データのみ、全量データの後に増分データを意味します。
tableName	`String`	テーブル名。
instanceName	`String`	インスタンス名。
stage	`TunnelStage`	トンネルのステージ。有効な値： `InitBaseDataAndStreamShard`、`ProcessBaseData`、`ProcessStream`。これらの値は、それぞれ初期化、全量データ処理、増分データ処理を意味します。
expired	`boolean`	トンネルデータが期限切れかどうかを示します。
streamTunnelConfig	`StreamTunnelConfig`	増分データ範囲の設定。設定していない場合は、デフォルトの設定が返ります。`BaseData` タイプのトンネルではこの設定を使用しません。フィールドの詳細については、「トンネルの作成」をご参照ください。
createTime	`long`	トンネルの作成時刻。値はミリ秒単位の UNIX タイムスタンプです。
streamRecordOptions	`StreamRecordOptions`	増分レコード内容の設定。設定していない場合は、デフォルトの設定が返ります。`BaseData` タイプのトンネルではこの設定を使用しません。このフィールドを使用するには、Tablestore Java 用 SDK 5.17.11 以降が必要です。フィールドの詳細については、「トンネルの作成」をご参照ください。