Configuration detail of a trigger.
JSON representation |
---|
{ "label": string, "startTasks": [ { object ( |
Fields | |
---|---|
label |
Optional. The user created label for a particular trigger. |
start |
Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration 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 integration execution graph). |
properties |
Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers. |
trigger |
Optional. type of trigger |
trigger |
Required. A number to uniquely identify each trigger config within the integration on UI. |
next |
Optional. Dictates how next tasks will be executed. |
trigger |
Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format:
Where trigger config has properties with value
|
description |
Optional. User-provided description intended to give additional business context about the task. |
cloud |
Optional. Cloud Scheduler Trigger related metadata |
error |
Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task |
position |
Optional. Informs the front-end application where to draw this error catcher config on the UI. |
trigger |
Optional. name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. |
input |
Optional. List of input variables for the api trigger. |
output |
Optional. List of output variables for the api trigger. |
TriggerType
Types of triggers.
Enums | |
---|---|
TRIGGER_TYPE_UNSPECIFIED |
Unknown. |
CRON |
Trigger by scheduled time. |
API |
Trigger by API call. |
SFDC_CHANNEL |
Trigger by Salesforce Channel. |
CLOUD_PUBSUB_EXTERNAL |
Trigger by Pub/Sub external. |
SFDC_CDC_CHANNEL |
SFDC Channel Trigger for CDC. |
CLOUD_SCHEDULER |
Trigger by Cloud Scheduler job. |
INTEGRATION_CONNECTOR_TRIGGER |
Trigger by Connector Event |
PRIVATE_TRIGGER |
Trigger for private workflow |
CLOUD_PUBSUB |
Trigger by cloud pub/sub for internal Application Integration |
CloudSchedulerConfig
Cloud Scheduler Trigger configuration
JSON representation |
---|
{ "serviceAccountEmail": string, "cronTab": string, "location": string, "errorMessage": string } |
Fields | |
---|---|
service |
Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time |
cron |
Required. The cron tab of cloud scheduler trigger. |
location |
Required. The location where associated cloud scheduler job will be created |
error |
Optional. When the job was deleted from Pantheon UI, errorMessage will be populated when Get/List integrations |
Variables
Variables names mapped to api trigger.
JSON representation |
---|
{ "names": [ string ] } |
Fields | |
---|---|
names[] |
Optional. List of variable names. |