TriggerConfig

Configuration detail of a trigger.

JSON representation
{
  "label": string,
  "startTasks": [
    {
      object (NextTask)
    }
  ],
  "properties": {
    string: string,
    ...
  },
  "triggerType": enum (TriggerType),
  "triggerNumber": string,
  "nextTasksExecutionPolicy": enum (NextTasksExecutionPolicy),
  "triggerId": string,
  "description": string,
  "cloudSchedulerConfig": {
    object (CloudSchedulerConfig)
  },
  "errorCatcherId": string,
  "position": {
    object (Coordinate)
  },
  "trigger": string,
  "inputVariables": {
    object (Variables)
  },
  "outputVariables": {
    object (Variables)
  }
}
Fields
label

string

Optional. The user created label for a particular trigger.

startTasks[]

object (NextTask)

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

map (key: string, value: string)

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.

triggerType

enum (TriggerType)

Optional. type of trigger

triggerNumber

string

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

nextTasksExecutionPolicy

enum (NextTasksExecutionPolicy)

Optional. Dictates how next tasks will be executed.

triggerId

string

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:

api_trigger/TRIGGER_NAME

Where trigger config has properties with value

{"Trigger name": TRIGGER_NAME}

description

string

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

cloudSchedulerConfig

object (CloudSchedulerConfig)

Optional. Cloud Scheduler Trigger related metadata

errorCatcherId

string

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

position

object (Coordinate)

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

trigger

string

Optional. name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.

inputVariables

object (Variables)

Optional. List of input variables for the api trigger.

outputVariables

object (Variables)

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
serviceAccountEmail

string

Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time

cronTab

string

Required. The cron tab of cloud scheduler trigger.

location

string

Required. The location where associated cloud scheduler job will be created

errorMessage

string

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[]

string

Optional. List of variable names.