简介
本文档提供关于数据万象文件处理哈希值计算任务的相关 API 概览以及 SDK 示例代码。
注意：
提交哈希值计算任务
功能说明
以提交任务的方式进行文件哈希值计算，异步返回计算得到的哈希值。
方法原型
public FileProcessJobResponse createFileProcessJob(FileProcessRequest request);
参数说明
Request 的具体数据描述如下：
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
tag | Request | 表示任务的类型，哈希值计算任务类型为：FileHashCode。 | String | 是 |
operation | Request | 包含哈希值计算的处理规则。 | Container | 是 |
queueId | Request | String | 否 | |
callBackFormat | Request | 任务回调格式，JSON 或 XML，默认 XML，优先级高于队列的回调格式。 | String | 否 |
callBackType | Request | 任务回调类型，Url 或 TDMQ，默认 Url，优先级高于队列的回调类型。 | String | 否 |
callBack | Request | 任务回调的地址，优先级高于队列的回调地址。 | String | 否 |
callBackMqConfig | Request | Container | 否 |
Input 的具体数据描述如下：
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
object | Request.Input | 文件名，取值为文件在当前存储桶中的完整名称。 | String | 是 |
Operation 的具体数据描述如下：
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
fileHashCodeConfig | Request.Operation | 指定哈希值计算的处理规则。 | Container | 是 |
userData | Request.Operation | 透传用户信息，可打印的 ASCII 码，长度不超过1024。 | String | 否 |
FileHashCodeConfig 的具体数据描述如下：
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
type | Request.Operation.FileHashCodeConfig | 哈希值的算法类型，有效值：MD5、SHA1、SHA256。 | String | 是 |
addToHeader | Request.Operation.FileHashCodeConfig | 是否将计算得到的哈希值添加至文件自定义 header, 有效值：true、false，默认值为 false。 自定义header根据 Type 的值变化，例如 Type 值为MD5时，自定义 heade r为 x-cos-meta-md5。 | String | 否 |
返回结果说明
成功：返回 FileProcessJobResponse 对象响应信息。
失败：发生错误（如 Bucket 不存在），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。
请求示例
//1.创建任务请求对象FileProcessRequest request = new FileProcessRequest();//2.添加请求参数 参数详情请见 api 接口文档request.setBucketName("demo-1234567890");request.setTag(FileProcessJobType.FileHashCode);request.getInput().setObject("input/1.mp4");FileHashCodeConfig fileHashCodeConfig = request.getOperation().getFileHashCodeConfig();fileHashCodeConfig.setType("MD5");fileHashCodeConfig.setAddToHeader("true");//3.调用接口,获取任务响应对象FileProcessJobResponse response = client.createFileProcessJob(request);
查询哈希值计算结果
功能说明
查询一个文件处理任务，根据任务 ID 查询任务详情。
方法原型
public FileProcessJobResponse describeFileProcessJob(FileProcessRequest request);
参数说明
参数名称 | 描述 | 类型 | 是否必选 |
bucketName | String | 是 | |
jobId | 要查询的任务 ID。 | String | 是 |
返回结果说明
成功： 返回任务详情响应包装类，类中包含一个 FileProcessJobResponse 任务详情对象。
失败： 发生错误（如身份认证失败），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。
请求示例
//1.创建任务请求对象FileProcessRequest request = new FileProcessRequest();//2.添加请求参数 参数详情请见 api 接口文档request.setBucketName("demo-1234567890");request.setJobId("fda7eb1607b8411ed8c182156726*****");//3.调用接口,获取任务响应对象FileProcessJobResponse response = client.describeFileProcessJob(request);
