Interface: $Properties

Properties of a CreateWorkflowRuleRequest.

Extended by

• ICreateWorkflowRuleRequest

Properties

description?

optional description?: string | null

Rule description.Will be stored with the rule.

---

forceScan?

optional forceScan?: boolean | null

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

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

---

namespace?

optional namespace?: string | null

CreateWorkflowRuleRequest namespace

---

requestId?

optional requestId?: string | null

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

---

spec?

optional spec?: $Properties | null

The rule specification .