com.tencentcloudapi.mps.v20190612.models

Class TaskNotifyConfig

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mps.v20190612.models.TaskNotifyConfig

public class TaskNotifyConfig
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
TaskNotifyConfig()
TaskNotifyConfig(TaskNotifyConfig 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
AwsSQS	getAwsSQS() Get The AWS SQS queue.
String	getCmqModel() Get The CMQ or TDMQ-CMQ model.
String	getCmqRegion() Get The CMQ or TDMQ-CMQ region, such as `sh` (Shanghai) or `bj` (Beijing).
String	getNotifyMode() Get Workflow notification method.
String	getNotifyType() Get The notification type.
String	getNotifyUrl() Get HTTP callback URL, required if `NotifyType` is set to `URL`
String	getQueueName() Get The CMQ or TDMQ-CMQ queue to receive notifications.
String	getTopicName() Get The CMQ or TDMQ-CMQ topic to receive notifications.
void	setAwsSQS(AwsSQS AwsSQS) Set The AWS SQS queue.
void	setCmqModel(String CmqModel) Set The CMQ or TDMQ-CMQ model.
void	setCmqRegion(String CmqRegion) Set The CMQ or TDMQ-CMQ region, such as `sh` (Shanghai) or `bj` (Beijing).
void	setNotifyMode(String NotifyMode) Set Workflow notification method.
void	setNotifyType(String NotifyType) Set The notification type.
void	setNotifyUrl(String NotifyUrl) Set HTTP callback URL, required if `NotifyType` is set to `URL`
void	setQueueName(String QueueName) Set The CMQ or TDMQ-CMQ queue to receive notifications.
void	setTopicName(String TopicName) Set The CMQ or TDMQ-CMQ topic to receive notifications.
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskNotifyConfig

public TaskNotifyConfig()

TaskNotifyConfig

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

getCmqModel

public String getCmqModel()

Get The CMQ or TDMQ-CMQ model. Valid values: Queue, Topic.

Returns:

CmqModel The CMQ or TDMQ-CMQ model. Valid values: Queue, Topic.

setCmqModel

public void setCmqModel(String CmqModel)

Set The CMQ or TDMQ-CMQ model. Valid values: Queue, Topic.

Parameters:

CmqModel - The CMQ or TDMQ-CMQ model. Valid values: Queue, Topic.

getCmqRegion

public String getCmqRegion()

Get The CMQ or TDMQ-CMQ region, such as `sh` (Shanghai) or `bj` (Beijing).

Returns:

CmqRegion The CMQ or TDMQ-CMQ region, such as `sh` (Shanghai) or `bj` (Beijing).

setCmqRegion

public void setCmqRegion(String CmqRegion)

Set The CMQ or TDMQ-CMQ region, such as `sh` (Shanghai) or `bj` (Beijing).

Parameters:

CmqRegion - The CMQ or TDMQ-CMQ region, such as `sh` (Shanghai) or `bj` (Beijing).

getTopicName

public String getTopicName()

Get The CMQ or TDMQ-CMQ topic to receive notifications. This parameter is valid when `CmqModel` is `Topic`.

Returns:

TopicName The CMQ or TDMQ-CMQ topic to receive notifications. This parameter is valid when `CmqModel` is `Topic`.

setTopicName

public void setTopicName(String TopicName)

Set The CMQ or TDMQ-CMQ topic to receive notifications. This parameter is valid when `CmqModel` is `Topic`.

Parameters:

TopicName - The CMQ or TDMQ-CMQ topic to receive notifications. This parameter is valid when `CmqModel` is `Topic`.

getQueueName

public String getQueueName()

Get The CMQ or TDMQ-CMQ queue to receive notifications. This parameter is valid when `CmqModel` is `Queue`.

Returns:

QueueName The CMQ or TDMQ-CMQ queue to receive notifications. This parameter is valid when `CmqModel` is `Queue`.

setQueueName

public void setQueueName(String QueueName)

Set The CMQ or TDMQ-CMQ queue to receive notifications. This parameter is valid when `CmqModel` is `Queue`.

Parameters:

QueueName - The CMQ or TDMQ-CMQ queue to receive notifications. This parameter is valid when `CmqModel` is `Queue`.

getNotifyMode

public String getNotifyMode()

Get Workflow notification method. Valid values: Finish, Change. If this parameter is left empty, `Finish` will be used.

Returns:

NotifyMode Workflow notification method. Valid values: Finish, Change. If this parameter is left empty, `Finish` will be used.

setNotifyMode

public void setNotifyMode(String NotifyMode)

Set Workflow notification method. Valid values: Finish, Change. If this parameter is left empty, `Finish` will be used.

Parameters:

NotifyMode - Workflow notification method. Valid values: Finish, Change. If this parameter is left empty, `Finish` will be used.

getNotifyType

public String getNotifyType()

Get The notification type. Valid values:

`CMQ`: This value is no longer used. Please use `TDMQ-CMQ` instead. `TDMQ-CMQ`: Message queue `URL`: If `NotifyType` is set to `URL`, HTTP callbacks are sent to the URL specified by `NotifyUrl`. HTTP and JSON are used for the callbacks. The packet contains the response parameters of the `ParseNotification` API. `SCF`: This notification type is not recommended. You need to configure it in the SCF console. `AWS-SQS`: AWS queue. This type is only supported for AWS tasks, and the queue must be in the same region as the AWS bucket. Note: If you do not pass this parameter or pass in an empty string, `CMQ` will be used. To use a different notification type, specify this parameter accordingly.

Returns:

NotifyType The notification type. Valid values:

`CMQ`: This value is no longer used. Please use `TDMQ-CMQ` instead.

`TDMQ-CMQ`: Message queue

`URL`: If `NotifyType` is set to `URL`, HTTP callbacks are sent to the URL specified by `NotifyUrl`. HTTP and JSON are used for the callbacks. The packet contains the response parameters of the `ParseNotification` API.

`SCF`: This notification type is not recommended. You need to configure it in the SCF console.

`AWS-SQS`: AWS queue. This type is only supported for AWS tasks, and the queue must be in the same region as the AWS bucket.

Note: If you do not pass this parameter or pass in an empty string, `CMQ` will be used. To use a different notification type, specify this parameter accordingly.

setNotifyType

public void setNotifyType(String NotifyType)

Set The notification type. Valid values:

`CMQ`: This value is no longer used. Please use `TDMQ-CMQ` instead. `TDMQ-CMQ`: Message queue `URL`: If `NotifyType` is set to `URL`, HTTP callbacks are sent to the URL specified by `NotifyUrl`. HTTP and JSON are used for the callbacks. The packet contains the response parameters of the `ParseNotification` API. `SCF`: This notification type is not recommended. You need to configure it in the SCF console. `AWS-SQS`: AWS queue. This type is only supported for AWS tasks, and the queue must be in the same region as the AWS bucket. Note: If you do not pass this parameter or pass in an empty string, `CMQ` will be used. To use a different notification type, specify this parameter accordingly.