com.volcengine.model.imagex.v2.CreateImageTranscodeTaskBody Maven / Gradle / Ivy
Show all versions of volc-sdk-java Show documentation
package com.volcengine.model.imagex.v2;
import com.alibaba.fastjson.JSON;
import java.util.List;
/**
* CreateImageTranscodeTaskBody
*/
@lombok.Data
public final class CreateImageTranscodeTaskBody {
/**
* 任务队列名称 ID。缺省情况下提交至账号默认任务队列。您可通过调用[GetImageTranscodeQueues](https://www.volcengine.com/docs/508/1160404)获取该账号下全部任务队列 ID。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "QueueId")
private String queueId;
/**
* 服务 ID。
*
*
*
* - 您可以在 veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。
*
* - 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "ServiceId")
private String serviceId;
/**
* 转码模板。您可通过调用 [GetAllImageTemplates](https://www.volcengine.com/docs/508/9386) 获取指定服务下全部模版信息。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Template")
private String template;
/**
* 数据类型，取值如下所示：
*
*
*
* - `uri`：指定 ServiceId 下存储 URI。
*
* - `url`：公网可访问的 URL。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "DataType")
private String dataType;
/**
* `DataList`和`Filelist`二选一必填，同时配置时，`DataList`优先生效。
*
*
*
* 待转码的图片 uri 或 url 列表，最多支持 10 万条。
*
*
*
* - 若`DataType`取值`uri`，此处请传入指定 ServiceId 下的存储 URI。
*
* - 若`DataType`取值`url`，此处请传入公网可访问的 URL。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "DataList")
private List dataList;
/**
* `DataList`和`Filelist`二选一必填，同时配置时，`DataList`优先生效。
*
*
*
* 待转码的图片 uri 或 url 文件列表。具体使用方式如下：
*
*
*
* 1. 在 txt、csv 文件内填写指定数据类型的待转码图片地址，每行填写一个，最多不超过 10 万条。
*
* 2. 将该文件上传至指定服务后，获取其存储 URI。
*
* 3. 将该存储 URI，传入 `FileList`。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "FileList")
private List fileList;
/**
* 转码产物的 Storekey 列表，仅当`DataList`不为空时有效，长度需与`DataList`长度一致。不传时默认使用固定规则生成产物的 Storekey。填写规则如下：
*
*
*
* - 使用 UTF-8 编码。
*
* - 长度必须在 1～1024 个字符之间。
*
* - 不能以反斜线（\）开头。
*
* - 不支持 `\a`、`\b`、`\t`、`\n`、`\v`、`\f`、`\r` 字符。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "ResKeyList")
private List resKeyList;
/**
* 转码是否保留 exif。取值如下所示：
*
*
*
* - `true`：保留
*
* - `false`：（默认）不保留
*/
@com.alibaba.fastjson.annotation.JSONField(name = "EnableExif")
private Boolean enableExif;
/**
* 任务回调配置。缺省情况下默认使用队列回调配置。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "CallbackConf")
private CreateImageTranscodeTaskBodyCallbackConf callbackConf;
@Override
public String toString() {
return JSON.toJSONString(this);
}
}