Skip to main content

Interface: $Properties

Properties of a WorkflowRuleSpec.

Extended by​

Properties​

actions?​

optional actions?: $Properties[] | null

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

activityStart?​

optional activityStart?: $Properties | null

WorkflowRuleSpec activityStart

expirationTime?​

optional expirationTime?: $Properties | null

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?: string | null

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?: string | null

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