com.tencentcloudapi.ess.v20201111.models.StartFlowRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-ess Show documentation
Show all versions of tencentcloud-sdk-java-ess 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.ess.v20201111.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 StartFlowRequest extends AbstractModel {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 合同流程ID，为32位字符串。
此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
*/
@SerializedName("FlowId")
@Expose
private String FlowId;
/**
* 客户端Token，保持接口幂等性,最大长度64个字符
*/
@SerializedName("ClientToken")
@Expose
private String ClientToken;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
- **0** :合同发起时通知通知对方来查看合同（默认）
- **1** : 签署完成后通知对方来查看合同
*/
@SerializedName("CcNotifyType")
@Expose
private Long CcNotifyType;
/**
* Get 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @return Operator 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @param Operator 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
/**
* Get 合同流程ID，为32位字符串。
此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
* @return FlowId 合同流程ID，为32位字符串。
此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
*/
public String getFlowId() {
return this.FlowId;
}
/**
* Set 合同流程ID，为32位字符串。
此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
* @param FlowId 合同流程ID，为32位字符串。
此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
*/
public void setFlowId(String FlowId) {
this.FlowId = FlowId;
}
/**
* Get 客户端Token，保持接口幂等性,最大长度64个字符
* @return ClientToken 客户端Token，保持接口幂等性,最大长度64个字符
* @deprecated
*/
@Deprecated
public String getClientToken() {
return this.ClientToken;
}
/**
* Set 客户端Token，保持接口幂等性,最大长度64个字符
* @param ClientToken 客户端Token，保持接口幂等性,最大长度64个字符
* @deprecated
*/
@Deprecated
public void setClientToken(String ClientToken) {
this.ClientToken = ClientToken;
}
/**
* Get 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
* @return Agent 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
public Agent getAgent() {
return this.Agent;
}
/**
* Set 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
* @param Agent 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
public void setAgent(Agent Agent) {
this.Agent = Agent;
}
/**
* Get 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
- **0** :合同发起时通知通知对方来查看合同（默认）
- **1** : 签署完成后通知对方来查看合同
* @return CcNotifyType 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
- **0** :合同发起时通知通知对方来查看合同（默认）
- **1** : 签署完成后通知对方来查看合同
*/
public Long getCcNotifyType() {
return this.CcNotifyType;
}
/**
* Set 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
- **0** :合同发起时通知通知对方来查看合同（默认）
- **1** : 签署完成后通知对方来查看合同
* @param CcNotifyType 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
- **0** :合同发起时通知通知对方来查看合同（默认）
- **1** : 签署完成后通知对方来查看合同
*/
public void setCcNotifyType(Long CcNotifyType) {
this.CcNotifyType = CcNotifyType;
}
public StartFlowRequest() {
}
/**
* 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 StartFlowRequest(StartFlowRequest source) {
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
if (source.FlowId != null) {
this.FlowId = new String(source.FlowId);
}
if (source.ClientToken != null) {
this.ClientToken = new String(source.ClientToken);
}
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
if (source.CcNotifyType != null) {
this.CcNotifyType = new Long(source.CcNotifyType);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamObj(map, prefix + "Operator.", this.Operator);
this.setParamSimple(map, prefix + "FlowId", this.FlowId);
this.setParamSimple(map, prefix + "ClientToken", this.ClientToken);
this.setParamObj(map, prefix + "Agent.", this.Agent);
this.setParamSimple(map, prefix + "CcNotifyType", this.CcNotifyType);
}
}