EnterpriseCrmFrontendsEventbusProtoTriggerConfigResponse

data class EnterpriseCrmFrontendsEventbusProtoTriggerConfigResponse(val alertConfig: List<EnterpriseCrmEventbusProtoWorkflowAlertConfigResponse>, val cloudSchedulerConfig: EnterpriseCrmEventbusProtoCloudSchedulerConfigResponse, val description: String, val enabledClients: List<String>, val errorCatcherId: String, val label: String, val nextTasksExecutionPolicy: String, val pauseWorkflowExecutions: Boolean, val position: EnterpriseCrmEventbusProtoCoordinateResponse, val properties: Map<String, String>, val startTasks: List<EnterpriseCrmEventbusProtoNextTaskResponse>, val triggerCriteria: EnterpriseCrmEventbusProtoTriggerCriteriaResponse, val triggerId: String, val triggerNumber: String, val triggerType: String)

Configuration detail of a trigger. Next available id: 19

Constructors

fun EnterpriseCrmFrontendsEventbusProtoTriggerConfigResponse(alertConfig: List<EnterpriseCrmEventbusProtoWorkflowAlertConfigResponse>, cloudSchedulerConfig: EnterpriseCrmEventbusProtoCloudSchedulerConfigResponse, description: String, enabledClients: List<String>, errorCatcherId: String, label: String, nextTasksExecutionPolicy: String, pauseWorkflowExecutions: Boolean, position: EnterpriseCrmEventbusProtoCoordinateResponse, properties: Map<String, String>, startTasks: List<EnterpriseCrmEventbusProtoNextTaskResponse>, triggerCriteria: EnterpriseCrmEventbusProtoTriggerCriteriaResponse, triggerId: String, triggerNumber: String, triggerType: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

An alert threshold configuration for the trigger + client + workflow tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per client + trigger + workflow when published.

Link copied to clipboard

User-provided description intended to give more business context about the task.

Link copied to clipboard

The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.

Link copied to clipboard

Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task

Link copied to clipboard

The user created label for a particular trigger.

Link copied to clipboard

Dictates how next tasks will be executed.

Link copied to clipboard

Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.

Link copied to clipboard

Optional. Informs the front-end application where to draw this trigger config on the UI.

Link copied to clipboard

Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.

Link copied to clipboard

Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).

Link copied to clipboard

Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.

Link copied to clipboard

The backend trigger ID.

Link copied to clipboard

A number to uniquely identify each trigger config within the workflow on UI.

Link copied to clipboard