Skip to main content

useUpdateProject

Agent Runtimes

Agent Runtimes / hooks/useProjects / useUpdateProject

Function: useUpdateProject()

useUpdateProject(): { assignAgent: (project, agentPodName, agentSpecId?) => Promise<any>; renameProject: (project, newName) => Promise<any>; unassignAgent: (project) => Promise<any>; } | { assignAgent: (project, agentPodName, agentSpecId?) => Promise<any>; renameProject: (project, newName) => Promise<any>; unassignAgent: (project) => Promise<any>; } | { assignAgent: (project, agentPodName, agentSpecId?) => Promise<any>; renameProject: (project, newName) => Promise<any>; unassignAgent: (project) => Promise<any>; } | { assignAgent: (project, agentPodName, agentSpecId?) => Promise<any>; renameProject: (project, newName) => Promise<any>; unassignAgent: (project) => Promise<any>; }

Defined in: src/hooks/useProjects.ts:187

Hook to update a project (e.g. persist the attached agent pod name). Uses the spacer PUT endpoint via useUpdateSpace.

Returns​

Type Literal​

{ assignAgent: (project, agentPodName, agentSpecId?) => Promise<any>; renameProject: (project, newName) => Promise<any>; unassignAgent: (project) => Promise<any>; }

assignAgent​

assignAgent: (project, agentPodName, agentSpecId?) => Promise<any>

Assign an agent runtime to the project

Parameters​
project​

ProjectData

agentPodName​

string

agentSpecId?​

string

Returns​

Promise<any>

renameProject​

renameProject: (project, newName) => Promise<any>

Rename a project

Parameters​
project​

ProjectData

newName​

string

Returns​

Promise<any>

unassignAgent​

unassignAgent: (project) => Promise<any>

Remove the agent assignment from the project

Parameters​
project​

ProjectData

Returns​

Promise<any>

Type Literal​

{ assignAgent: (project, agentPodName, agentSpecId?) => Promise<any>; renameProject: (project, newName) => Promise<any>; unassignAgent: (project) => Promise<any>; }

assignAgent​

assignAgent: (project, agentPodName, agentSpecId?) => Promise<any>

Assign an agent runtime to the project

Parameters​
project​

ProjectData

agentPodName​

string

agentSpecId?​

string

Returns​

Promise<any>

renameProject​

renameProject: (project, newName) => Promise<any>

Rename a project

Parameters​
project​

ProjectData

newName​

string

Returns​

Promise<any>

unassignAgent​

unassignAgent: (project) => Promise<any>

Remove the agent assignment from the project

Parameters​
project​

ProjectData

Returns​

Promise<any>

Type Literal​

{ assignAgent: (project, agentPodName, agentSpecId?) => Promise<any>; renameProject: (project, newName) => Promise<any>; unassignAgent: (project) => Promise<any>; }

assignAgent​

assignAgent: (project, agentPodName, agentSpecId?) => Promise<any>

Assign an agent runtime to the project

Parameters​
project​

ProjectData

agentPodName​

string

agentSpecId?​

string

Returns​

Promise<any>

renameProject​

renameProject: (project, newName) => Promise<any>

Rename a project

Parameters​
project​

ProjectData

newName​

string

Returns​

Promise<any>

unassignAgent​

unassignAgent: (project) => Promise<any>

Remove the agent assignment from the project

Parameters​
project​

ProjectData

Returns​

Promise<any>

Type Literal​

{ assignAgent: (project, agentPodName, agentSpecId?) => Promise<any>; renameProject: (project, newName) => Promise<any>; unassignAgent: (project) => Promise<any>; }

assignAgent​

assignAgent: (project, agentPodName, agentSpecId?) => Promise<any>

Assign an agent runtime to the project

Parameters​
project​

ProjectData

agentPodName​

string

agentSpecId?​

string

Returns​

Promise<any>

renameProject​

renameProject: (project, newName) => Promise<any>

Rename a project

Parameters​
project​

ProjectData

newName​

string

Returns​

Promise<any>

unassignAgent​

unassignAgent: (project) => Promise<any>

Remove the agent assignment from the project

Parameters​
project​

ProjectData

Returns​

Promise<any>