Class: RoutineBuilder

Defined in: packages/sdk/src/workspace-builder/automation.ts:66

Extends

• WorkspaceBuilderResource

Constructors

Constructor

new RoutineBuilder(name, cronSchedule?, options?): RoutineBuilder

Defined in: packages/sdk/src/workspace-builder/automation.ts:71

Parameters

name

string

cronSchedule?

string = ''

options?

AnyRecord = {}

Returns

RoutineBuilder

Overrides

WorkspaceBuilderResource.constructor

Properties

_created

_created: boolean = false

Defined in: packages/sdk/src/workspace-builder/resource.ts:23

Inherited from

WorkspaceBuilderResource._created

---

_existed

_existed: boolean = false

Defined in: packages/sdk/src/workspace-builder/resource.ts:24

Inherited from

WorkspaceBuilderResource._existed

---

_id?

optional _id: number

Defined in: packages/sdk/src/workspace-builder/resource.ts:21

Inherited from

WorkspaceBuilderResource._id

---

_uuid?

optional _uuid: string

Defined in: packages/sdk/src/workspace-builder/resource.ts:22

Inherited from

WorkspaceBuilderResource._uuid

---

active

readonly active: boolean

Defined in: packages/sdk/src/workspace-builder/automation.ts:67

---

cronSchedule

readonly cronSchedule: string = ''

Defined in: packages/sdk/src/workspace-builder/automation.ts:73

---

description

readonly description: string

Defined in: packages/sdk/src/workspace-builder/automation.ts:68

---

name

readonly name: string

Defined in: packages/sdk/src/workspace-builder/automation.ts:72

---

rules

readonly rules: RoutineRuleDraft[] = []

Defined in: packages/sdk/src/workspace-builder/automation.ts:69

Accessors

id

Get Signature

get id(): number

Defined in: packages/sdk/src/workspace-builder/resource.ts:27

Server-assigned numeric id — available after apply() or adopt().

Returns

number

Inherited from

WorkspaceBuilderResource.id

---

isImplicit

Get Signature

get isImplicit(): boolean

Defined in: packages/sdk/src/workspace-builder/resource.ts:53

True for resources the server creates on our behalf (currently a journey's Start step). They are kept in the resource list so edges can reference them, but they are never created, printed, or counted.

Returns

boolean

Inherited from

WorkspaceBuilderResource.isImplicit

---

uuid

Get Signature

get uuid(): string

Defined in: packages/sdk/src/workspace-builder/resource.ts:38

Server-assigned uuid — available after apply() or adopt().

Returns

string

Inherited from

WorkspaceBuilderResource.uuid

Methods

addRule()

addRule(actionType, options?): RoutineBuilder

Defined in: packages/sdk/src/workspace-builder/automation.ts:81

Parameters

actionType

string

options?

actionParams?

AnyRecord

memberFilter?

MemberFilterBuilder

workflow?

WorkflowBuilder

Returns

RoutineBuilder

---

adopt()

adopt(existing): void

Defined in: packages/sdk/src/workspace-builder/resource.ts:64

Parameters

existing

AnyRecord

Returns

void

Inherited from

WorkspaceBuilderResource.adopt

---

apply()

apply(client): Promise<void>

Defined in: packages/sdk/src/workspace-builder/automation.ts:107

Parameters

client

GravityRailWorkspaceClient

Returns

Promise<void>

Overrides

WorkspaceBuilderResource.apply

---

matchKey()

matchKey(): string | undefined

Defined in: packages/sdk/src/workspace-builder/resource.ts:60

Returns

string | undefined

Inherited from

WorkspaceBuilderResource.matchKey

---

planLine()

planLine(): string

Defined in: packages/sdk/src/workspace-builder/automation.ts:98

Returns

string

Overrides

WorkspaceBuilderResource.planLine