Interface: $Properties

v1.CreateWorkflowRuleRequest.$Properties

Properties of a CreateWorkflowRuleRequest.

Hierarchy

• $Properties

  ↳ ICreateWorkflowRuleRequest

Properties

description

• Optional description: null | string

Rule description.Will be stored with the rule.

---

forceScan

• Optional forceScan: null | boolean

If true, the rule will be applied to the currently running workflows via batch job. If not set , the rule will only be applied when triggering condition is satisfied. visibility_query in the rule will be used to select the workflows to apply the rule to.

---

identity

• Optional identity: null | string

Identity of the actor who created the rule. Will be stored with the rule.

---

namespace

• Optional namespace: null | string

CreateWorkflowRuleRequest namespace

---

requestId

• Optional requestId: null | string

Used to de-dupe requests. Typically should be UUID.

---

spec

• Optional spec: null | $Properties

The rule specification .