com.tencentcloudapi.ses.v20201002.models

Class SendTaskData

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ses.v20201002.models.SendTaskData

public class SendTaskData
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
SendTaskData()
SendTaskData(SendTaskData 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
Long	getCacheCount() Get Number of emails cached
String	getCreateTime() Get Task creation time
CycleEmailParam	getCycleParam() Get Parameters of a recurring task Note: This field may return `null`, indicating that no valid value can be found.
String	getErrMsg() Get Task exception information Note: This field may return `null`, indicating that no valid value can be found.
String	getFromEmailAddress() Get Sender address
Long	getReceiverId() Get Recipient group ID
String	getReceiversName() Get Recipient group name
Long	getRequestCount() Get Number of emails requested to be sent
Long	getSendCount() Get Number of emails sent
String	getSubject() Get Email subject
Long	getTaskId() Get Task ID
Long	getTaskStatus() Get Task status.
Long	getTaskType() Get Task type.
Template	getTemplate() Get Template and template data Note: This field may return `null`, indicating that no valid value can be found.
TimedEmailParam	getTimedParam() Get Parameters of a scheduled task Note: This field may return `null`, indicating that no valid value can be found.
String	getUpdateTime() Get Task update time
void	setCacheCount(Long CacheCount) Set Number of emails cached
void	setCreateTime(String CreateTime) Set Task creation time
void	setCycleParam(CycleEmailParam CycleParam) Set Parameters of a recurring task Note: This field may return `null`, indicating that no valid value can be found.
void	setErrMsg(String ErrMsg) Set Task exception information Note: This field may return `null`, indicating that no valid value can be found.
void	setFromEmailAddress(String FromEmailAddress) Set Sender address
void	setReceiverId(Long ReceiverId) Set Recipient group ID
void	setReceiversName(String ReceiversName) Set Recipient group name
void	setRequestCount(Long RequestCount) Set Number of emails requested to be sent
void	setSendCount(Long SendCount) Set Number of emails sent
void	setSubject(String Subject) Set Email subject
void	setTaskId(Long TaskId) Set Task ID
void	setTaskStatus(Long TaskStatus) Set Task status.
void	setTaskType(Long TaskType) Set Task type.
void	setTemplate(Template Template) Set Template and template data Note: This field may return `null`, indicating that no valid value can be found.
void	setTimedParam(TimedEmailParam TimedParam) Set Parameters of a scheduled task Note: This field may return `null`, indicating that no valid value can be found.
void	setUpdateTime(String UpdateTime) Set Task update time
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, 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

SendTaskData

public SendTaskData()

SendTaskData

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

getTaskId

public Long getTaskId()

Get Task ID

Returns:

TaskId Task ID

setTaskId

public void setTaskId(Long TaskId)

Set Task ID

Parameters:

TaskId - Task ID

getFromEmailAddress

public String getFromEmailAddress()

Get Sender address

Returns:

FromEmailAddress Sender address

setFromEmailAddress

public void setFromEmailAddress(String FromEmailAddress)

Set Sender address

Parameters:

FromEmailAddress - Sender address

getReceiverId

public Long getReceiverId()

Get Recipient group ID

Returns:

ReceiverId Recipient group ID

setReceiverId

public void setReceiverId(Long ReceiverId)

Set Recipient group ID

Parameters:

ReceiverId - Recipient group ID

getTaskStatus

public Long getTaskStatus()

Get Task status. `1`: to start; `5`: sending; `6`: sending suspended today; `7`: sending error; `10`: sent

Returns:

TaskStatus Task status. `1`: to start; `5`: sending; `6`: sending suspended today; `7`: sending error; `10`: sent

setTaskStatus

public void setTaskStatus(Long TaskStatus)

Set Task status. `1`: to start; `5`: sending; `6`: sending suspended today; `7`: sending error; `10`: sent

Parameters:

TaskStatus - Task status. `1`: to start; `5`: sending; `6`: sending suspended today; `7`: sending error; `10`: sent

getTaskType

public Long getTaskType()

Get Task type. `1`: immediate; `2`: scheduled; `3`: recurring

Returns:

TaskType Task type. `1`: immediate; `2`: scheduled; `3`: recurring

setTaskType

public void setTaskType(Long TaskType)

Set Task type. `1`: immediate; `2`: scheduled; `3`: recurring

Parameters:

TaskType - Task type. `1`: immediate; `2`: scheduled; `3`: recurring

getRequestCount

public Long getRequestCount()

Get Number of emails requested to be sent

Returns:

RequestCount Number of emails requested to be sent

setRequestCount

public void setRequestCount(Long RequestCount)

Set Number of emails requested to be sent

Parameters:

RequestCount - Number of emails requested to be sent

getSendCount

public Long getSendCount()

Get Number of emails sent

Returns:

SendCount Number of emails sent

setSendCount

public void setSendCount(Long SendCount)

Set Number of emails sent

Parameters:

SendCount - Number of emails sent

getCacheCount

public Long getCacheCount()

Get Number of emails cached

Returns:

CacheCount Number of emails cached

setCacheCount

public void setCacheCount(Long CacheCount)

Set Number of emails cached

Parameters:

CacheCount - Number of emails cached

getCreateTime

public String getCreateTime()

Get Task creation time

Returns:

CreateTime Task creation time

setCreateTime

public void setCreateTime(String CreateTime)

Set Task creation time

Parameters:

CreateTime - Task creation time

getUpdateTime

public String getUpdateTime()

Get Task update time

Returns:

UpdateTime Task update time

setUpdateTime

public void setUpdateTime(String UpdateTime)

Set Task update time

Parameters:

UpdateTime - Task update time

getSubject

public String getSubject()

Get Email subject

Returns:

Subject Email subject

setSubject

public void setSubject(String Subject)

Set Email subject

Parameters:

Subject - Email subject

getTemplate

public Template getTemplate()

Get Template and template data Note: This field may return `null`, indicating that no valid value can be found.

Returns:

Template Template and template data Note: This field may return `null`, indicating that no valid value can be found.

setTemplate

public void setTemplate(Template Template)

Set Template and template data Note: This field may return `null`, indicating that no valid value can be found.

Parameters:

Template - Template and template data Note: This field may return `null`, indicating that no valid value can be found.

getCycleParam

public CycleEmailParam getCycleParam()

Get Parameters of a recurring task Note: This field may return `null`, indicating that no valid value can be found.

Returns:

CycleParam Parameters of a recurring task Note: This field may return `null`, indicating that no valid value can be found.

setCycleParam

public void setCycleParam(CycleEmailParam CycleParam)

Set Parameters of a recurring task Note: This field may return `null`, indicating that no valid value can be found.

Parameters:

CycleParam - Parameters of a recurring task Note: This field may return `null`, indicating that no valid value can be found.

getTimedParam

public TimedEmailParam getTimedParam()

Get Parameters of a scheduled task Note: This field may return `null`, indicating that no valid value can be found.

Returns:

TimedParam Parameters of a scheduled task Note: This field may return `null`, indicating that no valid value can be found.

setTimedParam

public void setTimedParam(TimedEmailParam TimedParam)

Set Parameters of a scheduled task Note: This field may return `null`, indicating that no valid value can be found.

Parameters:

TimedParam - Parameters of a scheduled task Note: This field may return `null`, indicating that no valid value can be found.

getErrMsg

public String getErrMsg()

Get Task exception information Note: This field may return `null`, indicating that no valid value can be found.

Returns:

ErrMsg Task exception information Note: This field may return `null`, indicating that no valid value can be found.

setErrMsg

public void setErrMsg(String ErrMsg)

Set Task exception information Note: This field may return `null`, indicating that no valid value can be found.

Parameters:

ErrMsg - Task exception information Note: This field may return `null`, indicating that no valid value can be found.

getReceiversName

public String getReceiversName()

Get Recipient group name

Returns:

ReceiversName Recipient group name

setReceiversName

public void setReceiversName(String ReceiversName)

Set Recipient group name

Parameters:

ReceiversName - Recipient group name

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel