Trigger Management Models

Trigger Type Model

{ 
    "trigger_type_code":"string", 
    "display_name":"string", 
    "status":"string", 
    "event_codes":"array of string", 
    "description":"string" 
}

Table 1 describes the parameters in the trigger type model.

Trigger Instance Model

{ 
    "trigger_id":"string",
    "trigger_type_code":"string",
    "event_type_code":"string",
    "status":"string",
    "event_data":"json struct",
    "last_updated_time":"string",
    "created_time":"string" 
}

Table 2 describes the parameters in the trigger instance model.

Trigger Instance Data

• The data of a Simple Message Notification (SMN) trigger is as follows:

  { 
      "topic_urn":"string", 
      "subscription_status":"string" 
  } 

  Table 3 describes the parameters of an SMN trigger.

  Table 3 Parameters of an SMN trigger

  Parameter	Description
  topic_urn	URN of an SMN topic. This parameter is mandatory when you create an SMN trigger.
  subscription_status	Subscription status of a topic. Options: Unconfirmed and Confirmed.

• The data of an Object Storage Service (OBS) trigger is as follows:

  { 
     "bucket": "yourBucketName", 
     "events": ["s3:ObjectCreated:Put"], 
     "prefix": "yourPrefix", 
     "suffix": "yourSuffix" 
  }

  Table 4 Parameters of an OBS trigger

  Parameter	Description
  bucket	Bucket name. This parameter is mandatory.
  events	Collection of OBS trigger events. Options: s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:DeleteMarkerCreated, and s3:ObjectRemoved:Delete. This parameter is mandatory. Note that s3:objectcreated:* includes all events that start with s3:objectcreated, and s3:objectremoved:* includes all events that start with s3:objectremoved.
  prefix	Prefix of an OBS object. This parameter is optional.
  suffix	Suffix of an OBS object. This parameter is optional.

• The data of a timer trigger is as follows:

  {
  	"name": "string",
  	"schedule_type": "string",
  	"schedule": "string",
  	"user_event": "string"
  }

  Table 5 describes the parameters of a timer trigger.

  Table 5 Parameters of a timer trigger

  Parameter	Description
  name	Trigger name. This parameter is mandatory.
  schedule_type	Schedule type. Options: Rate or Cron. This parameter is mandatory.
  schedule	Schedule setting, which varies depending on the schedule type you choose. This parameter is mandatory. When schedule_type is set to Rate, add unit m, h, or d behind a rate, for example, 3m for 3 minutes.
  user_event	Additional information for calling a function. This parameter is optional.

• The data of a Kafka trigger is as follows:

  {
          "instance_id": "string",
  	"db_name": "string",
          "collection_name": "string",
          "db_user": "string",
  	"db_password": string,
          "batch_size": int,
  }

  Table 6 Parameters of a Kafka trigger

  Parameter	Description
  instance_id	Kafka instance ID.
  topic_id	Topic ID.
  kafka_user	Username.
  kafka_password	Password.
  kafka_ssl_enable	Whether to enable SSL authentication. If SSL authentication is enabled, the kafka_user and kafka_password fields are mandatory.
  batch_size	Batch size.