Skip to main content

Class: WorkspaceBuilder

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

Constructors​

Constructor​

new WorkspaceBuilder(client): WorkspaceBuilder

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

Parameters​

client​

GravityRailWorkspaceClient

Returns​

WorkspaceBuilder

Properties​

client​

readonly client: GravityRailWorkspaceClient

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

resources​

readonly resources: WorkspaceBuilderResource[] = []

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

Methods​

agent()​

agent(name, options?): AgentBuilder

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

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

AgentBuilder

apply()​

apply(): Promise<ResourceSummary>

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

Returns​

Promise<ResourceSummary>

form()​

form(name, options?): FormBuilder

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

Parameters​

name​

string

options?​

AnyRecord & object = {}

Returns​

FormBuilder

journey()​

journey(name, options?): JourneyBuilder

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

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

JourneyBuilder

label()​

label(name, options?): MemberLabelBuilder

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

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:95

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

MemberFilterBuilder

notificationRule()​

notificationRule(name, options?): NotificationRuleBuilder

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

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

NotificationRuleBuilder

plan()​

plan(): void

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

Returns​

void

preview()​

preview(): Promise<void>

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

Returns​

Promise<void>

roleUpdate()​

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

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

Parameters​

roleId​

number

workflowIds?​

number[]

dataTypeIds?​

number[]

Returns​

RoleUpdate

routine()​

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

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

Parameters​

name​

string

cronSchedule?​

string = ''

options?​

AnyRecord = {}

Returns​

RoutineBuilder

workflow()​

workflow(name, options?): WorkflowBuilder

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

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

WorkflowBuilder