Project

Datalayer Core

---

Datalayer Core / Project

Class: Project

Defined in: src/models/ProjectDTO.ts:55

Project domain model wrapping raw space data with project-specific accessors.

Example

const projects = await client.getProjects();
const project = projects[0];
console.log(project.hasAgent); // false
await client.assignAgent(project.uid, 'my-agent-pod');

Constructors

Constructor

new Project(data): ProjectDTO

Defined in: src/models/ProjectDTO.ts:60

Parameters

data

SpaceData

Returns

ProjectDTO

Accessors

attachedAgentGivenName

Get Signature

get attachedAgentGivenName(): string | undefined

Defined in: src/models/ProjectDTO.ts:129

Human-readable name of the attached agent runtime, if any.

Returns

string | undefined

---

attachedAgentPodName

Get Signature

get attachedAgentPodName(): string | undefined

Defined in: src/models/ProjectDTO.ts:117

Attached agent runtime pod name, if any.

Returns

string | undefined

---

attachedAgentSpecId

Get Signature

get attachedAgentSpecId(): string | undefined

Defined in: src/models/ProjectDTO.ts:123

Attached agent spec ID (e.g., 'data-acquisition'), if any.

Returns

string | undefined

---

createdAt

Get Signature

get createdAt(): Date

Defined in: src/models/ProjectDTO.ts:111

Creation date (stable across calls).

Returns

Date

---

description

Get Signature

get description(): string

Defined in: src/models/ProjectDTO.ts:93

Project description.

Returns

string

---

handle

Get Signature

get handle(): string

Defined in: src/models/ProjectDTO.ts:81

URL-friendly handle.

Returns

string

---

hasAgent

Get Signature

get hasAgent(): boolean

Defined in: src/models/ProjectDTO.ts:135

Whether an agent is currently attached to this project.

Returns

boolean

---

id

Get Signature

get id(): string

Defined in: src/models/ProjectDTO.ts:75

Internal numeric/string ID from the backend. Falls back to UID when not present. SDK client methods accept uid directly.

Returns

string

---

isDeleted

Get Signature

get isDeleted(): boolean

Defined in: src/models/ProjectDTO.ts:146

Whether this project has been deleted.

Returns

boolean

---

isPublic

Get Signature

get isPublic(): boolean

Defined in: src/models/ProjectDTO.ts:105

Whether the project is public.

Returns

boolean

---

name

Get Signature

get name(): string

Defined in: src/models/ProjectDTO.ts:87

Project name.

Returns

string

---

uid

Get Signature

get uid(): string

Defined in: src/models/ProjectDTO.ts:69

Unique identifier for the project.

Returns

string

---

variant

Get Signature

get variant(): string

Defined in: src/models/ProjectDTO.ts:99

Space variant (should be 'project').

Returns

string

Methods

markDeleted()

markDeleted(): void

Defined in: src/models/ProjectDTO.ts:141

Mark this project as deleted.

Returns

void

---

rawData()

rawData(): SpaceData

Defined in: src/models/ProjectDTO.ts:173

Get raw space data as received from the API.

Returns

SpaceData

---

toJSON()

toJSON(): ProjectJSON

Defined in: src/models/ProjectDTO.ts:154

Get project data in camelCase format.

Returns

ProjectJSON

Project data with camelCase properties

---

toString()

toString(): string

Defined in: src/models/ProjectDTO.ts:179

String representation of the project.

Returns

string