com.tencentcloudapi.ess.v20201111.models

Class DescribeFileUrlsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ess.v20201111.models.DescribeFileUrlsRequest

public class DescribeFileUrlsRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeFileUrlsRequest()
DescribeFileUrlsRequest(DescribeFileUrlsRequest 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[]	getBusinessIds() Get 业务编号的数组，取值如下：流程编号模板编号文档编号印章编号加签文件编号如需下载合同文件请传入FlowId，最大支持20个资源
String	getBusinessType() Get 文件对应的业务类型，目前支持：**FLOW ** : 如需下载合同文件请选择此项**TEMPLATE ** : 如需下载模板文件请选择此项**DOCUMENT **: 如需下载文档文件请选择此项**SEAL **: 如需下载印章图片请选择此项**DIGITFILE**: 如需下载加签文件请选择此项
String	getCcToken() Deprecated.
String	getFileName() Get 下载后的文件命名，只有FileType为zip的时候生效
String	getFileType() Get 要下载的文件类型，取值如下： JPG PDF ZIP
Long	getLimit() Get 指定分页每页返回的数据条数，如果不传默认为 20，单页最大支持 100。
Long	getOffset() Get 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0，最大 1000。
UserInfo	getOperator() Get 执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
String	getScene() Deprecated.
Long	getUrlTtl() Get 下载url过期时间，单位秒。0: 按默认值5分钟，允许范围：1s~24x60x60s(1天)
void	setAgent(Agent Agent) Set 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
void	setBusinessIds(String[] BusinessIds) Set 业务编号的数组，取值如下：流程编号模板编号文档编号印章编号加签文件编号如需下载合同文件请传入FlowId，最大支持20个资源
void	setBusinessType(String BusinessType) Set 文件对应的业务类型，目前支持：**FLOW ** : 如需下载合同文件请选择此项**TEMPLATE ** : 如需下载模板文件请选择此项**DOCUMENT **: 如需下载文档文件请选择此项**SEAL **: 如需下载印章图片请选择此项**DIGITFILE**: 如需下载加签文件请选择此项
void	setCcToken(String CcToken) Deprecated.
void	setFileName(String FileName) Set 下载后的文件命名，只有FileType为zip的时候生效
void	setFileType(String FileType) Set 要下载的文件类型，取值如下： JPG PDF ZIP
void	setLimit(Long Limit) Set 指定分页每页返回的数据条数，如果不传默认为 20，单页最大支持 100。
void	setOffset(Long Offset) Set 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0，最大 1000。
void	setOperator(UserInfo Operator) Set 执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
void	setScene(String Scene) Deprecated.
void	setUrlTtl(Long UrlTtl) Set 下载url过期时间，单位秒。0: 按默认值5分钟，允许范围：1s~24x60x60s(1天)
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

DescribeFileUrlsRequest

public DescribeFileUrlsRequest()

DescribeFileUrlsRequest

public DescribeFileUrlsRequest(DescribeFileUrlsRequest 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

getOperator

public UserInfo getOperator()

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

Returns:

Operator 执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

setOperator

public void setOperator(UserInfo Operator)

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

Parameters:

Operator - 执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

getBusinessType

public String getBusinessType()

Get 文件对应的业务类型，目前支持：

• **FLOW ** : 如需下载合同文件请选择此项
• **TEMPLATE ** : 如需下载模板文件请选择此项
• **DOCUMENT **: 如需下载文档文件请选择此项
• **SEAL **: 如需下载印章图片请选择此项
• **DIGITFILE**: 如需下载加签文件请选择此项

Returns:

BusinessType 文件对应的业务类型，目前支持：

• **FLOW ** : 如需下载合同文件请选择此项
• **TEMPLATE ** : 如需下载模板文件请选择此项
• **DOCUMENT **: 如需下载文档文件请选择此项
• **SEAL **: 如需下载印章图片请选择此项
• **DIGITFILE**: 如需下载加签文件请选择此项

setBusinessType

public void setBusinessType(String BusinessType)

Set 文件对应的业务类型，目前支持：

• **FLOW ** : 如需下载合同文件请选择此项
• **TEMPLATE ** : 如需下载模板文件请选择此项
• **DOCUMENT **: 如需下载文档文件请选择此项
• **SEAL **: 如需下载印章图片请选择此项
• **DIGITFILE**: 如需下载加签文件请选择此项

Parameters:

BusinessType - 文件对应的业务类型，目前支持：

• **FLOW ** : 如需下载合同文件请选择此项
• **TEMPLATE ** : 如需下载模板文件请选择此项
• **DOCUMENT **: 如需下载文档文件请选择此项
• **SEAL **: 如需下载印章图片请选择此项
• **DIGITFILE**: 如需下载加签文件请选择此项

getBusinessIds

public String[] getBusinessIds()

Get 业务编号的数组，取值如下：

• 流程编号
• 模板编号
• 文档编号
• 印章编号
• 加签文件编号
• 如需下载合同文件请传入FlowId，最大支持20个资源

Returns:

BusinessIds 业务编号的数组，取值如下：

• 流程编号
• 模板编号
• 文档编号
• 印章编号
• 加签文件编号
• 如需下载合同文件请传入FlowId，最大支持20个资源

setBusinessIds

public void setBusinessIds(String[] BusinessIds)

Set 业务编号的数组，取值如下：

• 流程编号
• 模板编号
• 文档编号
• 印章编号
• 加签文件编号
• 如需下载合同文件请传入FlowId，最大支持20个资源

Parameters:

BusinessIds - 业务编号的数组，取值如下：

• 流程编号
• 模板编号
• 文档编号
• 印章编号
• 加签文件编号
• 如需下载合同文件请传入FlowId，最大支持20个资源

getFileName

public String getFileName()

Get 下载后的文件命名，只有FileType为zip的时候生效

Returns:

FileName 下载后的文件命名，只有FileType为zip的时候生效

setFileName

public void setFileName(String FileName)

Set 下载后的文件命名，只有FileType为zip的时候生效

Parameters:

FileName - 下载后的文件命名，只有FileType为zip的时候生效

getFileType

public String getFileType()

Get 要下载的文件类型，取值如下：

• JPG
• PDF
• ZIP

Returns:

FileType 要下载的文件类型，取值如下：

• JPG
• PDF
• ZIP

setFileType

public void setFileType(String FileType)

Set 要下载的文件类型，取值如下：

• JPG
• PDF
• ZIP

Parameters:

FileType - 要下载的文件类型，取值如下：

• JPG
• PDF
• ZIP

getOffset

public Long getOffset()

Get 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0，最大 1000。

Returns:

Offset 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0，最大 1000。

setOffset

public void setOffset(Long Offset)

Set 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0，最大 1000。

Parameters:

Offset - 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0，最大 1000。

getLimit

public Long getLimit()

Get 指定分页每页返回的数据条数，如果不传默认为 20，单页最大支持 100。

Returns:

Limit 指定分页每页返回的数据条数，如果不传默认为 20，单页最大支持 100。

setLimit

public void setLimit(Long Limit)

Set 指定分页每页返回的数据条数，如果不传默认为 20，单页最大支持 100。

Parameters:

Limit - 指定分页每页返回的数据条数，如果不传默认为 20，单页最大支持 100。

getUrlTtl

public Long getUrlTtl()

Get 下载url过期时间，单位秒。0: 按默认值5分钟，允许范围：1s~24x60x60s(1天)

Returns:

UrlTtl 下载url过期时间，单位秒。0: 按默认值5分钟，允许范围：1s~24x60x60s(1天)

setUrlTtl

public void setUrlTtl(Long UrlTtl)

Set 下载url过期时间，单位秒。0: 按默认值5分钟，允许范围：1s~24x60x60s(1天)

Parameters:

UrlTtl - 下载url过期时间，单位秒。0: 按默认值5分钟，允许范围：1s~24x60x60s(1天)

getCcToken

@Deprecated
public String getCcToken()

Deprecated.

Get 暂不开放

Returns:

CcToken 暂不开放

setCcToken

@Deprecated
public void setCcToken(String CcToken)

Deprecated.

Set 暂不开放

Parameters:

CcToken - 暂不开放

getScene

@Deprecated
public String getScene()

Deprecated.

Get 暂不开放

Returns:

Scene 暂不开放

setScene

@Deprecated
public void setScene(String Scene)

Deprecated.

Set 暂不开放

Parameters:

Scene - 暂不开放

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.