Skip to main content

Class: WorkspaceBuilder

Defined in: packages/sdk/src/workspace-builder/orchestrator.ts:63

Constructors​

Constructor​

new WorkspaceBuilder(client): WorkspaceBuilder

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

Parameters​

client​

GravityRailWorkspaceClient

Returns​

WorkspaceBuilder

Properties​

client​

readonly client: GravityRailWorkspaceClient

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

resources​

readonly resources: WorkspaceBuilderResource[] = []

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

Methods​

agent()​

agent(name, options?): AgentBuilder

Defined in: packages/sdk/src/workspace-builder/orchestrator.ts:100

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

AgentBuilder

apply()​

apply(): Promise<ResourceSummary>

Defined in: packages/sdk/src/workspace-builder/orchestrator.ts:238

Returns​

Promise<ResourceSummary>

form()​

form(name, options?): FormBuilder

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

Parameters​

name​

string

options?​

AnyRecord & object = {}

Returns​

FormBuilder

journey()​

journey(name, options?): JourneyBuilder

Defined in: packages/sdk/src/workspace-builder/orchestrator.ts:94

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

JourneyBuilder

label()​

label(name, options?): MemberLabelBuilder

Defined in: packages/sdk/src/workspace-builder/orchestrator.ts:80

Parameters​

name​

string

options?​
color?​

string

description?​

string

slug?​

string

Returns​

MemberLabelBuilder

memberFilter()​

memberFilter(name, options?): MemberFilterBuilder

Defined in: packages/sdk/src/workspace-builder/orchestrator.ts:112

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

MemberFilterBuilder

notificationRule()​

notificationRule(name, options?): NotificationRuleBuilder

Defined in: packages/sdk/src/workspace-builder/orchestrator.ts:118

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

NotificationRuleBuilder

plan()​

plan(): void

Defined in: packages/sdk/src/workspace-builder/orchestrator.ts:130

Returns​

void

preflight()​

preflight(): string[]

Defined in: packages/sdk/src/workspace-builder/orchestrator.ts:206

Problems that make the plan unwritable, found before the first write.

The API validates each CEL when you save it, and its diagnosis is right — but it fires per-write, so a plan whose edges reference a non-collection form gets four labels, two forms, a workflow and six tasks created before the seventh call rejects it. The operator is left with a half-built program to hand-repair. Checking here costs nothing and writes nothing.

Deliberately narrow: only cross-resource facts the builder can see with certainty. Per-field CEL schema checking stays server-side, where the real validator lives — duplicating it here would drift.

Returns​

string[]

preview()​

preview(): Promise<void>

Defined in: packages/sdk/src/workspace-builder/orchestrator.ts:149

Returns​

Promise<void>

roleUpdate()​

roleUpdate(roleId, workflowIds?, dataTypeIds?): RoleUpdate

Defined in: packages/sdk/src/workspace-builder/orchestrator.ts:124

Parameters​

roleId​

number

workflowIds?​

number[]

dataTypeIds?​

number[]

Returns​

RoleUpdate

routine()​

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

Defined in: packages/sdk/src/workspace-builder/orchestrator.ts:106

Parameters​

name​

string

cronSchedule?​

string = ''

options?​

AnyRecord = {}

Returns​

RoutineBuilder

workflow()​

workflow(name, options?): WorkflowBuilder

Defined in: packages/sdk/src/workspace-builder/orchestrator.ts:74

Parameters​

name​

string

options?​

WorkflowBuilderOptions = {}

Returns​

WorkflowBuilder