com.tencentcloudapi.ess.v20201111.models

Class DescribeFlowTemplatesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ess.v20201111.models.DescribeFlowTemplatesRequest

public class DescribeFlowTemplatesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeFlowTemplatesRequest()
DescribeFlowTemplatesRequest(DescribeFlowTemplatesRequest 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	getApplicationId() Get 通过指定[第三方应用的应用号（ApplicationId）](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png)，您可以查询【应用模板库管理】中某个第三方应用下的模板。
Long	getContentType() Get 查询内容控制 **0**：模板列表及详情（默认） **1**：仅模板列表
Filter[]	getFilters() Get 搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。模板 ID：Key设置为 template-id ，Values为您想要查询的 模板 ID 列表。 主企业模板 ID：Key设置为 share-template-id ，Values为您想要查询的 主企业模板 ID 列表。用来查询主企业分享模板到子企业场景下，子企业的模板信息，在此情境下，参数 Agent.ProxyOrganizationId（子企业的组织ID）为必填项。 模板名称：Key设置为 template-name ，Values为您想要查询的模板名称列表。模板的用户合同类型：Key设置为 user-flow-type-id ，Values为您想要查询的用户模板类型id列表。
Long	getGenerateSource() Deprecated.
Boolean	getIsChannel() Deprecated.
Long	getLimit() Get 指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为200。`
Long	getOffset() Get 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`
UserInfo	getOperator() Get 执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
OrganizationInfo	getOrganization() Deprecated.
Boolean	getWithPreviewUrl() Get 是否获取模板预览链接。 false：不获取（默认）true：需要获取 设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
void	setAgent(Agent Agent) Set 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
void	setApplicationId(String ApplicationId) Set 通过指定[第三方应用的应用号（ApplicationId）](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png)，您可以查询【应用模板库管理】中某个第三方应用下的模板。
void	setContentType(Long ContentType) Set 查询内容控制 **0**：模板列表及详情（默认） **1**：仅模板列表
void	setFilters(Filter[] Filters) Set 搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。模板 ID：Key设置为 template-id ，Values为您想要查询的 模板 ID 列表。 主企业模板 ID：Key设置为 share-template-id ，Values为您想要查询的 主企业模板 ID 列表。用来查询主企业分享模板到子企业场景下，子企业的模板信息，在此情境下，参数 Agent.ProxyOrganizationId（子企业的组织ID）为必填项。 模板名称：Key设置为 template-name ，Values为您想要查询的模板名称列表。模板的用户合同类型：Key设置为 user-flow-type-id ，Values为您想要查询的用户模板类型id列表。
void	setGenerateSource(Long GenerateSource) Deprecated.
void	setIsChannel(Boolean IsChannel) Deprecated.
void	setLimit(Long Limit) Set 指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为200。`
void	setOffset(Long Offset) Set 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`
void	setOperator(UserInfo Operator) Set 执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
void	setOrganization(OrganizationInfo Organization) Deprecated.
void	setWithPreviewUrl(Boolean WithPreviewUrl) Set 是否获取模板预览链接。 false：不获取（默认）true：需要获取 设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
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

DescribeFlowTemplatesRequest

public DescribeFlowTemplatesRequest()

DescribeFlowTemplatesRequest

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

getAgent

public Agent getAgent()

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

Returns:

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

setAgent

public void setAgent(Agent Agent)

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

Parameters:

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

getContentType

public Long getContentType()

Get 查询内容控制

• **0**：模板列表及详情（默认）
• **1**：仅模板列表

Returns:

ContentType 查询内容控制

• **0**：模板列表及详情（默认）
• **1**：仅模板列表

setContentType

public void setContentType(Long ContentType)

Set 查询内容控制

• **0**：模板列表及详情（默认）
• **1**：仅模板列表

Parameters:

ContentType - 查询内容控制

• **0**：模板列表及详情（默认）
• **1**：仅模板列表

getFilters

public Filter[] getFilters()

Get 搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。

• 模板 ID：Key设置为 template-id ，Values为您想要查询的 模板 ID 列表。
• 主企业模板 ID：Key设置为 share-template-id ，Values为您想要查询的 主企业模板 ID 列表。用来查询主企业分享模板到子企业场景下，子企业的模板信息，在此情境下，参数 Agent.ProxyOrganizationId（子企业的组织ID）为必填项。
• 模板名称：Key设置为 template-name ，Values为您想要查询的模板名称列表。
• 模板的用户合同类型：Key设置为 user-flow-type-id ，Values为您想要查询的用户模板类型id列表。

Returns:

Filters 搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。

• 模板 ID：Key设置为 template-id ，Values为您想要查询的 模板 ID 列表。
• 主企业模板 ID：Key设置为 share-template-id ，Values为您想要查询的 主企业模板 ID 列表。用来查询主企业分享模板到子企业场景下，子企业的模板信息，在此情境下，参数 Agent.ProxyOrganizationId（子企业的组织ID）为必填项。
• 模板名称：Key设置为 template-name ，Values为您想要查询的模板名称列表。
• 模板的用户合同类型：Key设置为 user-flow-type-id ，Values为您想要查询的用户模板类型id列表。

setFilters

public void setFilters(Filter[] Filters)

Set 搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。

• 模板 ID：Key设置为 template-id ，Values为您想要查询的 模板 ID 列表。
• 主企业模板 ID：Key设置为 share-template-id ，Values为您想要查询的 主企业模板 ID 列表。用来查询主企业分享模板到子企业场景下，子企业的模板信息，在此情境下，参数 Agent.ProxyOrganizationId（子企业的组织ID）为必填项。
• 模板名称：Key设置为 template-name ，Values为您想要查询的模板名称列表。
• 模板的用户合同类型：Key设置为 user-flow-type-id ，Values为您想要查询的用户模板类型id列表。

Parameters:

Filters - 搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。

• 模板 ID：Key设置为 template-id ，Values为您想要查询的 模板 ID 列表。
• 主企业模板 ID：Key设置为 share-template-id ，Values为您想要查询的 主企业模板 ID 列表。用来查询主企业分享模板到子企业场景下，子企业的模板信息，在此情境下，参数 Agent.ProxyOrganizationId（子企业的组织ID）为必填项。
• 模板名称：Key设置为 template-name ，Values为您想要查询的模板名称列表。
• 模板的用户合同类型：Key设置为 user-flow-type-id ，Values为您想要查询的用户模板类型id列表。

getOffset

public Long getOffset()

Get 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`

Returns:

Offset 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`

setOffset

public void setOffset(Long Offset)

Set 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`

Parameters:

Offset - 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`

getLimit

public Long getLimit()

Get 指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为200。`

Returns:

Limit 指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为200。`

setLimit

public void setLimit(Long Limit)

Set 指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为200。`

Parameters:

Limit - 指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为200。`

getApplicationId

public String getApplicationId()

Get 通过指定[第三方应用的应用号（ApplicationId）](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png)，您可以查询【应用模板库管理】中某个第三方应用下的模板。

注意事项：

• 当 ApplicationId 为空时（默认），系统将查询平台企业的所有模板（自建应用使用的模板）。
• 当 ApplicationId 不为空时，系统将从【应用模板库管理】中查询该特定应用下的模板（分享给第三方应用子企业的模板）。

Returns:

ApplicationId 通过指定[第三方应用的应用号（ApplicationId）](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png)，您可以查询【应用模板库管理】中某个第三方应用下的模板。

注意事项：

• 当 ApplicationId 为空时（默认），系统将查询平台企业的所有模板（自建应用使用的模板）。
• 当 ApplicationId 不为空时，系统将从【应用模板库管理】中查询该特定应用下的模板（分享给第三方应用子企业的模板）。

setApplicationId

public void setApplicationId(String ApplicationId)

Set 通过指定[第三方应用的应用号（ApplicationId）](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png)，您可以查询【应用模板库管理】中某个第三方应用下的模板。

注意事项：

• 当 ApplicationId 为空时（默认），系统将查询平台企业的所有模板（自建应用使用的模板）。
• 当 ApplicationId 不为空时，系统将从【应用模板库管理】中查询该特定应用下的模板（分享给第三方应用子企业的模板）。

Parameters:

ApplicationId - 通过指定[第三方应用的应用号（ApplicationId）](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png)，您可以查询【应用模板库管理】中某个第三方应用下的模板。

注意事项：

• 当 ApplicationId 为空时（默认），系统将查询平台企业的所有模板（自建应用使用的模板）。
• 当 ApplicationId 不为空时，系统将从【应用模板库管理】中查询该特定应用下的模板（分享给第三方应用子企业的模板）。

getIsChannel

@Deprecated
public Boolean getIsChannel()

Deprecated.

Get 默认为false，查询SaaS模板库列表； 为true，查询第三方应用集成平台企业模板库管理列表

Returns:

IsChannel 默认为false，查询SaaS模板库列表； 为true，查询第三方应用集成平台企业模板库管理列表

setIsChannel

@Deprecated
public void setIsChannel(Boolean IsChannel)

Deprecated.

Set 默认为false，查询SaaS模板库列表； 为true，查询第三方应用集成平台企业模板库管理列表

Parameters:

IsChannel - 默认为false，查询SaaS模板库列表； 为true，查询第三方应用集成平台企业模板库管理列表

getOrganization

@Deprecated
public OrganizationInfo getOrganization()

Deprecated.

Get 暂未开放

Returns:

Organization 暂未开放

setOrganization

@Deprecated
public void setOrganization(OrganizationInfo Organization)

Deprecated.

Set 暂未开放

Parameters:

Organization - 暂未开放

getGenerateSource

@Deprecated
public Long getGenerateSource()

Deprecated.

Get 暂未开放

Returns:

GenerateSource 暂未开放

setGenerateSource

@Deprecated
public void setGenerateSource(Long GenerateSource)

Deprecated.

Set 暂未开放

Parameters:

GenerateSource - 暂未开放

getWithPreviewUrl

public Boolean getWithPreviewUrl()

Get 是否获取模板预览链接。

• false：不获取（默认）
• true：需要获取

设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。

Returns:

WithPreviewUrl 是否获取模板预览链接。

• false：不获取（默认）
• true：需要获取

设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。

setWithPreviewUrl

public void setWithPreviewUrl(Boolean WithPreviewUrl)

Set 是否获取模板预览链接。

• false：不获取（默认）
• true：需要获取

设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。

Parameters:

WithPreviewUrl - 是否获取模板预览链接。

• false：不获取（默认）
• true：需要获取

设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。

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.