Skip to main content

Class: WorkflowBuilder

Defined in: packages/sdk/src/workspace-builder/workflows.ts:136

Extends​

  • WorkspaceBuilderResource

Constructors​

Constructor​

new WorkflowBuilder(name, options?): WorkflowBuilder

Defined in: packages/sdk/src/workspace-builder/workflows.ts:143

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

WorkflowBuilder

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

abilities​

readonly abilities: AbilityDef[] = []

Defined in: packages/sdk/src/workspace-builder/workflows.ts:141

description​

readonly description: string

Defined in: packages/sdk/src/workspace-builder/workflows.ts:137

name​

readonly name: string

Defined in: packages/sdk/src/workspace-builder/workflows.ts:144

prompt?​

readonly optional prompt: string

Defined in: packages/sdk/src/workspace-builder/workflows.ts:138

tasks​

readonly tasks: TaskBuilder[] = []

Defined in: packages/sdk/src/workspace-builder/workflows.ts:140

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

startTask​

Get Signature​

get startTask(): TaskBuilder | undefined

Defined in: packages/sdk/src/workspace-builder/workflows.ts:170

Returns​

TaskBuilder | undefined

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​

ability()​

ability(abilityType, options?): WorkflowBuilder

Defined in: packages/sdk/src/workspace-builder/workflows.ts:165

Parameters​

abilityType​

string

options?​

AnyRecord = {}

Returns​

WorkflowBuilder

adopt()​

adopt(existing): void

Defined in: packages/sdk/src/workspace-builder/workflows.ts:178

Parameters​

existing​

AnyRecord

Returns​

void

Overrides​

WorkspaceBuilderResource.adopt

apply()​

apply(client): Promise<void>

Defined in: packages/sdk/src/workspace-builder/workflows.ts:202

Parameters​

client​

GravityRailWorkspaceClient

Returns​

Promise<void>

Overrides​

WorkspaceBuilderResource.apply

matchKey()​

matchKey(): string

Defined in: packages/sdk/src/workspace-builder/workflows.ts:174

Returns​

string

Overrides​

WorkspaceBuilderResource.matchKey

needsDefaultAgent()​

needsDefaultAgent(): boolean

Defined in: packages/sdk/src/workspace-builder/workflows.ts:194

Returns​

boolean

planLine()​

planLine(): string

Defined in: packages/sdk/src/workspace-builder/workflows.ts:187

Returns​

string

Overrides​

WorkspaceBuilderResource.planLine

setAgentId()​

setAgentId(agentId): void

Defined in: packages/sdk/src/workspace-builder/workflows.ts:198

Parameters​

agentId​

number

Returns​

void

task()​

task(name, options?): TaskBuilder

Defined in: packages/sdk/src/workspace-builder/workflows.ts:153

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

TaskBuilder