com.tencentcloudapi.essbasic.v20210526.models.ChannelCreateReleaseFlowRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-essbasic Show documentation
Show all versions of tencentcloud-sdk-java-essbasic Show documentation
Tencent Cloud Open API SDK for Java
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.essbasic.v20210526.models;
import com.tencentcloudapi.common.AbstractModel;
import com.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class ChannelCreateReleaseFlowRequest extends AbstractModel {
/**
* 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* 待解除的签署流程编号(即原签署流程的编号)。
[点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
*/
@SerializedName("NeedRelievedFlowId")
@Expose
private String NeedRelievedFlowId;
/**
* 解除协议内容, 包括解除理由等信息。
*/
@SerializedName("ReliveInfo")
@Expose
private RelieveInfo ReliveInfo;
/**
* 替换解除协议的签署人， 如不指定新的签署人，将继续使用原流程的签署人作为本解除协议的参与方。
如需更换原合同中的企业端签署人，可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口DescribeFlowDetailInfo查询签署人的ApproverNumber编号，默认从0开始，顺序递增)
注：
1. 支持更换企业的签署人，不支持更换个人类型的签署人。
2. 己方企业支持自动签署，他方企业不支持自动签署。
3. 仅将需要替换的签署人添加至此列表，无需替换的签署人无需添加进来。
*/
@SerializedName("ReleasedApprovers")
@Expose
private ReleasedApprover [] ReleasedApprovers;
/**
* 签署完回调url，最大长度1000个字符
*/
@SerializedName("CallbackUrl")
@Expose
private String CallbackUrl;
/**
* 暂未开放
*/
@SerializedName("Organization")
@Expose
private OrganizationInfo Organization;
/**
* 暂未开放
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 合同流程的签署截止时间，格式为Unix标准时间戳(秒)，如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
*/
@SerializedName("Deadline")
@Expose
private Long Deadline;
/**
* 调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
*/
@SerializedName("UserData")
@Expose
private String UserData;
/**
* Get 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
* @return Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
*/
public Agent getAgent() {
return this.Agent;
}
/**
* Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
* @param Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
*/
public void setAgent(Agent Agent) {
this.Agent = Agent;
}
/**
* Get 待解除的签署流程编号(即原签署流程的编号)。
[点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
* @return NeedRelievedFlowId 待解除的签署流程编号(即原签署流程的编号)。
[点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
*/
public String getNeedRelievedFlowId() {
return this.NeedRelievedFlowId;
}
/**
* Set 待解除的签署流程编号(即原签署流程的编号)。
[点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
* @param NeedRelievedFlowId 待解除的签署流程编号(即原签署流程的编号)。
[点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
*/
public void setNeedRelievedFlowId(String NeedRelievedFlowId) {
this.NeedRelievedFlowId = NeedRelievedFlowId;
}
/**
* Get 解除协议内容, 包括解除理由等信息。
* @return ReliveInfo 解除协议内容, 包括解除理由等信息。
*/
public RelieveInfo getReliveInfo() {
return this.ReliveInfo;
}
/**
* Set 解除协议内容, 包括解除理由等信息。
* @param ReliveInfo 解除协议内容, 包括解除理由等信息。
*/
public void setReliveInfo(RelieveInfo ReliveInfo) {
this.ReliveInfo = ReliveInfo;
}
/**
* Get 替换解除协议的签署人， 如不指定新的签署人，将继续使用原流程的签署人作为本解除协议的参与方。
如需更换原合同中的企业端签署人，可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口DescribeFlowDetailInfo查询签署人的ApproverNumber编号，默认从0开始，顺序递增)
注：
1. 支持更换企业的签署人，不支持更换个人类型的签署人。
2. 己方企业支持自动签署，他方企业不支持自动签署。
3. 仅将需要替换的签署人添加至此列表，无需替换的签署人无需添加进来。
* @return ReleasedApprovers 替换解除协议的签署人， 如不指定新的签署人，将继续使用原流程的签署人作为本解除协议的参与方。
如需更换原合同中的企业端签署人，可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口DescribeFlowDetailInfo查询签署人的ApproverNumber编号，默认从0开始，顺序递增)
注：
1. 支持更换企业的签署人，不支持更换个人类型的签署人。
2. 己方企业支持自动签署，他方企业不支持自动签署。
3. 仅将需要替换的签署人添加至此列表，无需替换的签署人无需添加进来。
*/
public ReleasedApprover [] getReleasedApprovers() {
return this.ReleasedApprovers;
}
/**
* Set 替换解除协议的签署人， 如不指定新的签署人，将继续使用原流程的签署人作为本解除协议的参与方。
如需更换原合同中的企业端签署人，可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口DescribeFlowDetailInfo查询签署人的ApproverNumber编号，默认从0开始，顺序递增)
注：
1. 支持更换企业的签署人，不支持更换个人类型的签署人。
2. 己方企业支持自动签署，他方企业不支持自动签署。
3. 仅将需要替换的签署人添加至此列表，无需替换的签署人无需添加进来。
* @param ReleasedApprovers 替换解除协议的签署人， 如不指定新的签署人，将继续使用原流程的签署人作为本解除协议的参与方。
如需更换原合同中的企业端签署人，可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口DescribeFlowDetailInfo查询签署人的ApproverNumber编号，默认从0开始，顺序递增)
注：
1. 支持更换企业的签署人，不支持更换个人类型的签署人。
2. 己方企业支持自动签署，他方企业不支持自动签署。
3. 仅将需要替换的签署人添加至此列表，无需替换的签署人无需添加进来。
*/
public void setReleasedApprovers(ReleasedApprover [] ReleasedApprovers) {
this.ReleasedApprovers = ReleasedApprovers;
}
/**
* Get 签署完回调url，最大长度1000个字符
* @return CallbackUrl 签署完回调url，最大长度1000个字符
* @deprecated
*/
@Deprecated
public String getCallbackUrl() {
return this.CallbackUrl;
}
/**
* Set 签署完回调url，最大长度1000个字符
* @param CallbackUrl 签署完回调url，最大长度1000个字符
* @deprecated
*/
@Deprecated
public void setCallbackUrl(String CallbackUrl) {
this.CallbackUrl = CallbackUrl;
}
/**
* Get 暂未开放
* @return Organization 暂未开放
* @deprecated
*/
@Deprecated
public OrganizationInfo getOrganization() {
return this.Organization;
}
/**
* Set 暂未开放
* @param Organization 暂未开放
* @deprecated
*/
@Deprecated
public void setOrganization(OrganizationInfo Organization) {
this.Organization = Organization;
}
/**
* Get 暂未开放
* @return Operator 暂未开放
* @deprecated
*/
@Deprecated
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 暂未开放
* @param Operator 暂未开放
* @deprecated
*/
@Deprecated
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
/**
* Get 合同流程的签署截止时间，格式为Unix标准时间戳(秒)，如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
* @return Deadline 合同流程的签署截止时间，格式为Unix标准时间戳(秒)，如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
*/
public Long getDeadline() {
return this.Deadline;
}
/**
* Set 合同流程的签署截止时间，格式为Unix标准时间戳(秒)，如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
* @param Deadline 合同流程的签署截止时间，格式为Unix标准时间戳(秒)，如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
*/
public void setDeadline(Long Deadline) {
this.Deadline = Deadline;
}
/**
* Get 调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
* @return UserData 调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
*/
public String getUserData() {
return this.UserData;
}
/**
* Set 调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
* @param UserData 调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
*/
public void setUserData(String UserData) {
this.UserData = UserData;
}
public ChannelCreateReleaseFlowRequest() {
}
/**
* 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.
*/
public ChannelCreateReleaseFlowRequest(ChannelCreateReleaseFlowRequest source) {
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
if (source.NeedRelievedFlowId != null) {
this.NeedRelievedFlowId = new String(source.NeedRelievedFlowId);
}
if (source.ReliveInfo != null) {
this.ReliveInfo = new RelieveInfo(source.ReliveInfo);
}
if (source.ReleasedApprovers != null) {
this.ReleasedApprovers = new ReleasedApprover[source.ReleasedApprovers.length];
for (int i = 0; i < source.ReleasedApprovers.length; i++) {
this.ReleasedApprovers[i] = new ReleasedApprover(source.ReleasedApprovers[i]);
}
}
if (source.CallbackUrl != null) {
this.CallbackUrl = new String(source.CallbackUrl);
}
if (source.Organization != null) {
this.Organization = new OrganizationInfo(source.Organization);
}
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
if (source.Deadline != null) {
this.Deadline = new Long(source.Deadline);
}
if (source.UserData != null) {
this.UserData = new String(source.UserData);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamObj(map, prefix + "Agent.", this.Agent);
this.setParamSimple(map, prefix + "NeedRelievedFlowId", this.NeedRelievedFlowId);
this.setParamObj(map, prefix + "ReliveInfo.", this.ReliveInfo);
this.setParamArrayObj(map, prefix + "ReleasedApprovers.", this.ReleasedApprovers);
this.setParamSimple(map, prefix + "CallbackUrl", this.CallbackUrl);
this.setParamObj(map, prefix + "Organization.", this.Organization);
this.setParamObj(map, prefix + "Operator.", this.Operator);
this.setParamSimple(map, prefix + "Deadline", this.Deadline);
this.setParamSimple(map, prefix + "UserData", this.UserData);
}
}