列出投递任务

更新时间:
复制 MD 格式

Java SDK 可列出指定数据表下的投递任务,并返回各任务的名称和类型。

前提条件

  • 安装Tablestore Java SDK并初始化客户端。数据湖投递功能需要 5.10.3 及以上版本,建议使用最新版本。

功能说明

调用 listDeliveryTask 方法列出指定数据表下的所有投递任务。

public ListDeliveryTaskResponse listDeliveryTask(ListDeliveryTaskRequest request)
        throws TableStoreException, ClientException

以下示例列出 example_table 数据表下的投递任务,并打印每个任务的摘要信息。client 为已初始化的客户端。

String tableName = "example_table";
ListDeliveryTaskRequest request = new ListDeliveryTaskRequest(tableName);

ListDeliveryTaskResponse response = client.listDeliveryTask(request);
for (DeliveryTaskInfo taskInfo : response.getTaskInfos()) {
    System.out.println("tableName: " + taskInfo.getTableName());
    System.out.println("taskName: " + taskInfo.getTaskName());
    System.out.println("taskType: " + taskInfo.getTaskType());
}

参数说明

request 的类型为 ListDeliveryTaskRequest,包含以下参数。

名称

类型

说明

tableName(必选)

String

数据表名称。

返回值

返回 ListDeliveryTaskResponsetaskInfos 的类型为 List<DeliveryTaskInfo>,包含指定数据表下的投递任务摘要;如果数据表下没有投递任务,则返回空列表。

投递任务信息

taskInfos[] 中每个元素的类型为 DeliveryTaskInfo,包含以下字段。

名称

类型

说明

tableName

String

数据表名称。

taskName

String

投递任务名称。

taskType

DeliveryTaskType

投递任务类型。取值包括 BASE(全量投递)、INC(增量投递)和 BASE_INC(先全量投递,再持续增量投递)。