com.tencentcloudapi.ess.v20201111.models

Class UploadFilesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ess.v20201111.models.UploadFilesRequest

public class UploadFilesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
UploadFilesRequest()
UploadFilesRequest(UploadFilesRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
Agent	getAgent() Get 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
String	getBusinessType() Get 文件对应业务类型,可以选择的类型如下 **TEMPLATE** : 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过创建文件转换任务转换后才能使用 **DOCUMENT** : 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件，用来发起流程，还需要通过创建文件转换任务转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同，直接上传后使用返回的文件资源Id即可 **SEAL** : 此文件用于印章的生成，文件类型支持.jpg/.jpeg/.png ["yDRSRUUgygj6rq2wUuO4zjEyBZ2NHiyT"]
Caller	getCaller() Get 执行本接口操作的员工信息。其中OperatorId为必填字段，即用户的UserId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
Boolean	getCoverRect() Get 此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。 **true**：将灰色矩阵置为白色。 **false**：无需处理，不会将灰色矩阵置为白色（默认）。 注: `该参数仅在关键字定位时，需要去除关键字所在的灰框场景下使用。`
String[]	getCustomIds() Get 该字段已不再使用
UploadFile[]	getFileInfos() Get 请上传文件内容数组，最多可上传20个文件。 所有文件必须符合FileType指定的文件类型。
String	getFileType() Get 文件类型， 默认通过文件内容和文件后缀一起解析得到文件类型，调用接口时可以显示的指定上传文件的类型。 可支持的指定类型如下: pdf doc docx xls xlsx html jpg jpeg png 如：pdf 表示上传的文件 张三入职合同.pdf的文件类型是 pdf
String	getFileUrls() Deprecated.
void	setAgent(Agent Agent) Set 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
void	setBusinessType(String BusinessType) Set 文件对应业务类型,可以选择的类型如下 **TEMPLATE** : 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过创建文件转换任务转换后才能使用 **DOCUMENT** : 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件，用来发起流程，还需要通过创建文件转换任务转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同，直接上传后使用返回的文件资源Id即可 **SEAL** : 此文件用于印章的生成，文件类型支持.jpg/.jpeg/.png ["yDRSRUUgygj6rq2wUuO4zjEyBZ2NHiyT"]
void	setCaller(Caller Caller) Set 执行本接口操作的员工信息。其中OperatorId为必填字段，即用户的UserId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
void	setCoverRect(Boolean CoverRect) Set 此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。 **true**：将灰色矩阵置为白色。 **false**：无需处理，不会将灰色矩阵置为白色（默认）。 注: `该参数仅在关键字定位时，需要去除关键字所在的灰框场景下使用。`
void	setCustomIds(String[] CustomIds) Set 该字段已不再使用
void	setFileInfos(UploadFile[] FileInfos) Set 请上传文件内容数组，最多可上传20个文件。 所有文件必须符合FileType指定的文件类型。
void	setFileType(String FileType) Set 文件类型， 默认通过文件内容和文件后缀一起解析得到文件类型，调用接口时可以显示的指定上传文件的类型。 可支持的指定类型如下: pdf doc docx xls xlsx html jpg jpeg png 如：pdf 表示上传的文件 张三入职合同.pdf的文件类型是 pdf
void	setFileUrls(String FileUrls) Deprecated.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UploadFilesRequest

public UploadFilesRequest()

UploadFilesRequest

public UploadFilesRequest(UploadFilesRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getBusinessType

public String getBusinessType()

Get 文件对应业务类型,可以选择的类型如下

• **TEMPLATE** : 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过创建文件转换任务转换后才能使用
• **DOCUMENT** : 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件，用来发起流程，还需要通过创建文件转换任务转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同，直接上传后使用返回的文件资源Id即可
• **SEAL** : 此文件用于印章的生成，文件类型支持.jpg/.jpeg/.png

["yDRSRUUgygj6rq2wUuO4zjEyBZ2NHiyT"]

Returns:

BusinessType 文件对应业务类型,可以选择的类型如下

• **TEMPLATE** : 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过创建文件转换任务转换后才能使用
• **DOCUMENT** : 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件，用来发起流程，还需要通过创建文件转换任务转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同，直接上传后使用返回的文件资源Id即可
• **SEAL** : 此文件用于印章的生成，文件类型支持.jpg/.jpeg/.png

["yDRSRUUgygj6rq2wUuO4zjEyBZ2NHiyT"]

setBusinessType

public void setBusinessType(String BusinessType)

Set 文件对应业务类型,可以选择的类型如下

• **TEMPLATE** : 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过创建文件转换任务转换后才能使用
• **DOCUMENT** : 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件，用来发起流程，还需要通过创建文件转换任务转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同，直接上传后使用返回的文件资源Id即可
• **SEAL** : 此文件用于印章的生成，文件类型支持.jpg/.jpeg/.png

["yDRSRUUgygj6rq2wUuO4zjEyBZ2NHiyT"]

Parameters:

BusinessType - 文件对应业务类型,可以选择的类型如下

• **TEMPLATE** : 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过创建文件转换任务转换后才能使用
• **DOCUMENT** : 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件，用来发起流程，还需要通过创建文件转换任务转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同，直接上传后使用返回的文件资源Id即可
• **SEAL** : 此文件用于印章的生成，文件类型支持.jpg/.jpeg/.png

["yDRSRUUgygj6rq2wUuO4zjEyBZ2NHiyT"]

getCaller

public Caller getCaller()

Get 执行本接口操作的员工信息。其中OperatorId为必填字段，即用户的UserId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

Returns:

Caller 执行本接口操作的员工信息。其中OperatorId为必填字段，即用户的UserId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

setCaller

public void setCaller(Caller Caller)

Set 执行本接口操作的员工信息。其中OperatorId为必填字段，即用户的UserId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

Parameters:

Caller - 执行本接口操作的员工信息。其中OperatorId为必填字段，即用户的UserId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

getFileInfos

public UploadFile[] getFileInfos()

Get 请上传文件内容数组，最多可上传20个文件。 所有文件必须符合FileType指定的文件类型。

Returns:

FileInfos 请上传文件内容数组，最多可上传20个文件。 所有文件必须符合FileType指定的文件类型。

setFileInfos

public void setFileInfos(UploadFile[] FileInfos)

Set 请上传文件内容数组，最多可上传20个文件。 所有文件必须符合FileType指定的文件类型。

Parameters:

FileInfos - 请上传文件内容数组，最多可上传20个文件。 所有文件必须符合FileType指定的文件类型。

getFileType

public String getFileType()

Get 文件类型， 默认通过文件内容和文件后缀一起解析得到文件类型，调用接口时可以显示的指定上传文件的类型。 可支持的指定类型如下:

• pdf
• doc
• docx
• xls
• xlsx
• html
• jpg
• jpeg
• png

如：pdf 表示上传的文件 张三入职合同.pdf的文件类型是 pdf

Returns:

FileType 文件类型， 默认通过文件内容和文件后缀一起解析得到文件类型，调用接口时可以显示的指定上传文件的类型。 可支持的指定类型如下:

• pdf
• doc
• docx
• xls
• xlsx
• html
• jpg
• jpeg
• png

如：pdf 表示上传的文件 张三入职合同.pdf的文件类型是 pdf

setFileType

public void setFileType(String FileType)

Set 文件类型， 默认通过文件内容和文件后缀一起解析得到文件类型，调用接口时可以显示的指定上传文件的类型。 可支持的指定类型如下:

• pdf
• doc
• docx
• xls
• xlsx
• html
• jpg
• jpeg
• png

如：pdf 表示上传的文件 张三入职合同.pdf的文件类型是 pdf

Parameters:

FileType - 文件类型， 默认通过文件内容和文件后缀一起解析得到文件类型，调用接口时可以显示的指定上传文件的类型。 可支持的指定类型如下:

• pdf
• doc
• docx
• xls
• xlsx
• html
• jpg
• jpeg
• png

如：pdf 表示上传的文件 张三入职合同.pdf的文件类型是 pdf

getCoverRect

public Boolean getCoverRect()

Get 此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。

• **true**：将灰色矩阵置为白色。
• **false**：无需处理，不会将灰色矩阵置为白色（默认）。

注: `该参数仅在关键字定位时，需要去除关键字所在的灰框场景下使用。`

Returns:

CoverRect 此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。

• **true**：将灰色矩阵置为白色。
• **false**：无需处理，不会将灰色矩阵置为白色（默认）。

注: `该参数仅在关键字定位时，需要去除关键字所在的灰框场景下使用。`

setCoverRect

public void setCoverRect(Boolean CoverRect)

Set 此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。

• **true**：将灰色矩阵置为白色。
• **false**：无需处理，不会将灰色矩阵置为白色（默认）。

注: `该参数仅在关键字定位时，需要去除关键字所在的灰框场景下使用。`

Parameters:

CoverRect - 此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。

• **true**：将灰色矩阵置为白色。
• **false**：无需处理，不会将灰色矩阵置为白色（默认）。

注: `该参数仅在关键字定位时，需要去除关键字所在的灰框场景下使用。`

getCustomIds

public String[] getCustomIds()

Get 该字段已不再使用

Returns:

CustomIds 该字段已不再使用

setCustomIds

public void setCustomIds(String[] CustomIds)

Set 该字段已不再使用

Parameters:

CustomIds - 该字段已不再使用

getFileUrls

@Deprecated
public String getFileUrls()

Deprecated.

Get 不再使用，上传文件链接数组，最多支持20个URL

Returns:

FileUrls 不再使用，上传文件链接数组，最多支持20个URL

setFileUrls

@Deprecated
public void setFileUrls(String FileUrls)

Deprecated.

Set 不再使用，上传文件链接数组，最多支持20个URL

Parameters:

FileUrls - 不再使用，上传文件链接数组，最多支持20个URL

getAgent

public Agent getAgent()

Get 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Returns:

Agent 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

setAgent

public void setAgent(Agent Agent)

Set 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

Agent - 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.