EnterpriseCrmFrontendsEventbusProtoTriggerConfig class

Configuration detail of a trigger. Next available id: 20

Constructors

EnterpriseCrmFrontendsEventbusProtoTriggerConfig({Input<List<EnterpriseCrmEventbusProtoWorkflowAlertConfig>>? alertConfig, Input<EnterpriseCrmEventbusProtoCloudSchedulerConfig>? cloudSchedulerConfig, Input<String>? description, required Input<List<String>> enabledClients, Input<String>? errorCatcherId, Input<String>? label, Input<EnterpriseCrmFrontendsEventbusProtoTriggerConfigNextTasksExecutionPolicy>? nextTasksExecutionPolicy, Input<bool>? pauseWorkflowExecutions, Input<EnterpriseCrmEventbusProtoCoordinate>? position, Input<Map<String, String>>? properties, Input<List<EnterpriseCrmEventbusProtoNextTask>>? startTasks, Input<EnterpriseCrmEventbusProtoTriggerCriteria>? triggerCriteria, Input<String>? triggerId, Input<String>? triggerName, required Input<String> triggerNumber, Input<EnterpriseCrmFrontendsEventbusProtoTriggerConfigTriggerType>? triggerType})
Creates a new EnterpriseCrmFrontendsEventbusProtoTriggerConfig. alertConfig 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. cloudSchedulerConfig Optional. description User-provided description intended to give more business context about the task. enabledClients 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. errorCatcherId Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task label The user created label for a particular trigger. nextTasksExecutionPolicy Dictates how next tasks will be executed. pauseWorkflowExecutions 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. position Optional. Informs the front-end application where to draw this trigger config on the UI. properties 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. startTasks 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). triggerCriteria 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. triggerId The backend trigger ID. triggerName Optional. Name of the trigger This is added to identify the type of trigger. This is avoid the logic on triggerId to identify the trigger_type and push the same to monitoring. triggerNumber A number to uniquely identify each trigger config within the workflow on UI. triggerType Optional.
const
EnterpriseCrmFrontendsEventbusProtoTriggerConfig.fromMap(Map<String, dynamic> map)
factory

Properties

alertConfig → Input<List<EnterpriseCrmEventbusProtoWorkflowAlertConfig>>?
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.
final
cloudSchedulerConfig → Input<EnterpriseCrmEventbusProtoCloudSchedulerConfig>?
final
description → Input<String>?
User-provided description intended to give more business context about the task.
final
enabledClients → Input<List<String>>
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.
final
errorCatcherId → Input<String>?
Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
final
hashCode → int
The hash code for this object.
no setterinherited
label → Input<String>?
The user created label for a particular trigger.
final
nextTasksExecutionPolicy → Input<EnterpriseCrmFrontendsEventbusProtoTriggerConfigNextTasksExecutionPolicy>?
Dictates how next tasks will be executed.
final
pauseWorkflowExecutions → Input<bool>?
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.
final
position → Input<EnterpriseCrmEventbusProtoCoordinate>?
Optional. Informs the front-end application where to draw this trigger config on the UI.
final
properties → Input<Map<String, String>>?
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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startTasks → Input<List<EnterpriseCrmEventbusProtoNextTask>>?
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).
final
triggerCriteria → Input<EnterpriseCrmEventbusProtoTriggerCriteria>?
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.
final
triggerId → Input<String>?
The backend trigger ID.
final
triggerName → Input<String>?
Optional. Name of the trigger This is added to identify the type of trigger. This is avoid the logic on triggerId to identify the trigger_type and push the same to monitoring.
final
triggerNumber → Input<String>
A number to uniquely identify each trigger config within the workflow on UI.
final
triggerType → Input<EnterpriseCrmFrontendsEventbusProtoTriggerConfigTriggerType>?
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited