Skip to main content

Interface: $Properties

v1.WorkflowRuleSpec.$Properties

Properties of a WorkflowRuleSpec.

Hierarchy

Properties

actions

Optional actions: null | $Properties[]

WorkflowRuleAction to be taken when the rule is triggered and predicate is matched.


activityStart

Optional activityStart: null | $Properties

WorkflowRuleSpec activityStart


expirationTime

Optional expirationTime: null | $Properties

Expiration time of the rule. After this time, the rule will be deleted. Can be empty if the rule should never expire.


id

Optional id: null | string

The id of the new workflow rule. Must be unique within the namespace. Can be set by the user, and can have business meaning.


trigger

Optional trigger: "activityStart"

Specifies how the rule should be triggered and evaluated. Currently, only "activity start" type is supported.


visibilityQuery

Optional visibilityQuery: null | string

Restricted Visibility query. This query is used to filter workflows in this namespace to which this rule should apply. It is applied to any running workflow each time a triggering event occurs, before the trigger predicate is evaluated. The following workflow attributes are supported:

  • WorkflowType
  • WorkflowId
  • StartTime
  • ExecutionStatus