Skip to main content

Abstract Class: WorkspaceBuilderResource

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

Extended by​

Constructors​

Constructor​

new WorkspaceBuilderResource(): WorkspaceBuilderResource

Returns​

WorkspaceBuilderResource

Properties​

_created​

_created: boolean = false

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

_existed​

_existed: boolean = false

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

_id?​

optional _id: number

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

_uuid?​

optional _uuid: string

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

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

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

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

Methods​

adopt()​

adopt(existing): void

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

Parameters​

existing​

AnyRecord

Returns​

void

apply()​

abstract apply(client): Promise<void>

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

Parameters​

client​

GravityRailWorkspaceClient

Returns​

Promise<void>

matchKey()​

matchKey(): string | undefined

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

Returns​

string | undefined

planLine()​

abstract planLine(): string

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

Returns​

string