表格存储 Java SDK 查询投递任务信息 - 表格存储

前提条件

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

功能说明

调用 describeDeliveryTask 方法查询指定投递任务的配置和运行状态。

public DescribeDeliveryTaskResponse describeDeliveryTask(DescribeDeliveryTaskRequest request)
        throws TableStoreException, ClientException

以下示例查询 example_table 数据表中 example_task 投递任务的信息，并打印任务类型、OSS 目录前缀和同步阶段。client 为已初始化的客户端。

String tableName = "example_table";
String taskName = "example_task";
DescribeDeliveryTaskRequest request =
        new DescribeDeliveryTaskRequest(tableName, taskName);

DescribeDeliveryTaskResponse response = client.describeDeliveryTask(request);
System.out.println("taskType: " + response.getTaskType());
System.out.println("ossPrefix: " + response.getTaskConfig().getOssPrefix());
System.out.println("taskSyncPhase: "
        + response.getTaskSyncStat().getTaskSyncPhase());

参数说明

request 的类型为 DescribeDeliveryTaskRequest，包含以下参数。

名称	类型	说明
tableName（必选）	String	数据表名称。
taskName（必选）	String	投递任务名称。

返回值

返回 DescribeDeliveryTaskResponse，包含以下业务字段。

名称	类型	说明
taskConfig	OSSTaskConfig	OSS 投递配置。
taskSyncStat	TaskSyncStat	投递任务的同步状态。
taskType	DeliveryTaskType	投递任务类型。取值包括 `BASE`（全量投递）、`INC`（增量投递）和 `BASE_INC`（先全量投递，再持续增量投递）。

OSS 投递配置

taskConfig 的类型为 OSSTaskConfig，包含以下字段。

名称	类型	说明
ossPrefix	String	OSS Bucket 中的目录前缀。
ossBucket	String	OSS Bucket 名称。
ossEndpoint	String	OSS Bucket 所在地域的服务地址。
ossStsRole	String	服务关联角色 `AliyunServiceRoleForOTSDataDelivery` 的 ARN。
parquetSchema	List<ParquetSchema>	投递字段列表。列表顺序与 Parquet 文件中的字段顺序一致。
eventTimeColumn	EventColumn	事件时间列。未设置事件时间列时，该字段为空。
format	OSSFileFormat	OSS 文件格式。当前值为 `Parquet`。
timeFormatter	TimeFormatter	OSS 分区格式。当前值为 `YDMFormatter`，表示年、月、日格式。

投递字段

taskConfig.parquetSchema[] 中每个元素的类型为 ParquetSchema，包含以下字段。

名称	类型	说明
columnName	String	Tablestore 数据表中的源字段名称。
ossColumnName	String	字段投递到 OSS 后的名称。
type	DataType	字段在 Parquet 文件中的目标类型。
encode	OSSFileEncoding	Parquet 编码方式。
typeExtend	String	Parquet 扩展类型。当前不支持，因此该字段为空。

事件时间列

taskConfig.eventTimeColumn 的类型为 EventColumn，包含以下字段。

名称	类型	说明
columnName	String	作为事件时间的源字段名称。
timeFormat	EventTimeFormat	事件时间格式。取值包括 `RFC822`、`RFC850`、`RFC1123`、`RFC3339` 和 `Unix`。

同步状态

taskSyncStat 的类型为 TaskSyncStat，包含以下字段。

名称	类型	说明
taskSyncPhase	TaskSyncPhase	同步阶段。取值包括 `INIT`（初始化）、`FULL`（全量同步）和 `INCR`（增量同步）。
currentSyncPoint	Date	当前同步时间点。
errorType	DeliveryErrorType	错误类型。取值包括 `OK`（无错误）、`UNAUTHORIZED`（无权限）和 `INVALID_OSS_BUCKET`（OSS Bucket 无效）。
detail	String	同步状态或错误的详细信息。