TriggerConfig

Configuration detail of a trigger. Next available id: 15

JSON representation
{
  "label": string,
  "startTasks": [
    {
      object (NextTask)
    }
  ],
  "properties": {
    string: string,
    ...
  },
  "triggerType": enum (TriggerType),
  "position": {
    object (Coordinate)
  },
  "triggerNumber": string,
  "alertConfig": [
    {
      object (WorkflowAlertConfig)
    }
  ],
  "nextTasksExecutionPolicy": enum (NextTasksExecutionPolicy),
  "enabledClients": [
    string
  ],
  "pauseWorkflowExecutions": boolean,
  "triggerCriteria": {
    object (TriggerCriteria)
  },
  "triggerId": string
}
Fields
label

string

The user created label for a particular trigger.

startTasks[]

object (NextTask)

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).

properties

map (key: string, value: 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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

triggerType

enum (TriggerType)

position

object (Coordinate)

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

triggerNumber

string

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

alertConfig[]

object (WorkflowAlertConfig)

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.

nextTasksExecutionPolicy

enum (NextTasksExecutionPolicy)

Dictates how next tasks will be executed.

enabledClients[]

string

Required. 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.

pauseWorkflowExecutions

boolean

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.

triggerCriteria

object (TriggerCriteria)

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

triggerId

string

The backend trigger ID.