Class WorkspaceService

Index

Constructors

Methods

createWorkspace createWorkspaceModDeps deleteWorkspace getWorkspace getWorkspaceConfigs listWorkspace updateWorkspace updateWorkspaceConfigs validateWorkspaceConfigs

Constructors

constructor

new WorkspaceService(): WorkspaceService
Returns WorkspaceService

Methods

`Static`createWorkspace

createWorkspace<ThrowOnError extends boolean = false>(
    options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & CreateWorkspaceData & Pick<
        RequestOptions<ThrowOnError, string>,
        "headers",
    >,
): RequestResult<entity_Workspace, unknown, ThrowOnError>
Create workspace Create a new workspace
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & CreateWorkspaceData & Pick<
  RequestOptions<ThrowOnError, string>,
  "headers",
  >
Returns RequestResult<entity_Workspace, unknown, ThrowOnError>
- Defined in sdk.gen.ts:535

`Static`createWorkspaceModDeps

createWorkspaceModDeps<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & CreateWorkspaceModDepsData,
): RequestResult<string, unknown, ThrowOnError>
Create the module dependencies of the workspace Create the module dependencies in kcl.mod of the specified workspace
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & CreateWorkspaceModDepsData
Returns RequestResult<string, unknown, ThrowOnError>
- Defined in sdk.gen.ts:601

`Static`deleteWorkspace

deleteWorkspace<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & DeleteWorkspaceData,
): RequestResult<string, unknown, ThrowOnError>
Delete workspace Delete specified workspace by ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & DeleteWorkspaceData
Returns RequestResult<string, unknown, ThrowOnError>
- Defined in sdk.gen.ts:546

`Static`getWorkspace

getWorkspace<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GetWorkspaceData,
): RequestResult<entity_Workspace, unknown, ThrowOnError>
Get workspace Get workspace information by workspace ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GetWorkspaceData
Returns RequestResult<entity_Workspace, unknown, ThrowOnError>
- Defined in sdk.gen.ts:557

`Static`getWorkspaceConfigs

getWorkspaceConfigs<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GetWorkspaceConfigsData,
): RequestResult<request_WorkspaceConfigs, unknown, ThrowOnError>
get workspace configurations Get configurations in the specified workspace
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GetWorkspaceConfigsData
Returns RequestResult<request_WorkspaceConfigs, unknown, ThrowOnError>
- Defined in sdk.gen.ts:579

`Static`listWorkspace

listWorkspace<ThrowOnError extends boolean = false>(
options?: OmitKeys<RequestOptions<ThrowOnError, string>, "url">,
): RequestResult<entity_Workspace, unknown, ThrowOnError>
List workspaces List all workspaces
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- Optionaloptions: OmitKeys<RequestOptions<ThrowOnError, string>, "url">
Returns RequestResult<entity_Workspace, unknown, ThrowOnError>
- Defined in sdk.gen.ts:524

`Static`updateWorkspace

updateWorkspace<ThrowOnError extends boolean = false>(
    options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & UpdateWorkspaceData & Pick<
        RequestOptions<ThrowOnError, string>,
        "headers",
    >,
): RequestResult<entity_Workspace, unknown, ThrowOnError>
Update workspace Update the specified workspace
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & UpdateWorkspaceData & Pick<
  RequestOptions<ThrowOnError, string>,
  "headers",
  >
Returns RequestResult<entity_Workspace, unknown, ThrowOnError>
- Defined in sdk.gen.ts:568

`Static`updateWorkspaceConfigs

updateWorkspaceConfigs<ThrowOnError extends boolean = false>(
    options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & UpdateWorkspaceConfigsData & Pick<
        RequestOptions<ThrowOnError, string>,
        "headers",
    >,
): RequestResult<request_WorkspaceConfigs, unknown, ThrowOnError>
Update workspace configurations Update the configurations in the specified workspace
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & UpdateWorkspaceConfigsData & Pick<
  RequestOptions<ThrowOnError, string>,
  "headers",
  >
Returns RequestResult<request_WorkspaceConfigs, unknown, ThrowOnError>
- Defined in sdk.gen.ts:590

`Static`validateWorkspaceConfigs

validateWorkspaceConfigs<ThrowOnError extends boolean = false>(
    options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & ValidateWorkspaceConfigsData & Pick<
        RequestOptions<ThrowOnError, string>,
        "headers",
    >,
): RequestResult<request_WorkspaceConfigs, unknown, ThrowOnError>
Validate workspace configurations Validate the configurations in the specified workspace
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & ValidateWorkspaceConfigsData & Pick<
  RequestOptions<ThrowOnError, string>,
  "headers",
  >
Returns RequestResult<request_WorkspaceConfigs, unknown, ThrowOnError>
- Defined in sdk.gen.ts:612

Class WorkspaceService

Index

Constructors

Methods

Constructors

constructor

Returns WorkspaceService

Methods

StaticcreateWorkspace

Type Parameters

Parameters

Returns RequestResult<entity_Workspace, unknown, ThrowOnError>

StaticcreateWorkspaceModDeps

Type Parameters

Parameters

Returns RequestResult<string, unknown, ThrowOnError>

StaticdeleteWorkspace

Type Parameters

Parameters

Returns RequestResult<string, unknown, ThrowOnError>

StaticgetWorkspace

Type Parameters

Parameters

Returns RequestResult<entity_Workspace, unknown, ThrowOnError>

StaticgetWorkspaceConfigs

Type Parameters

Parameters

Returns RequestResult<request_WorkspaceConfigs, unknown, ThrowOnError>

StaticlistWorkspace

Type Parameters

Parameters

Returns RequestResult<entity_Workspace, unknown, ThrowOnError>

StaticupdateWorkspace

Type Parameters

Parameters

Returns RequestResult<entity_Workspace, unknown, ThrowOnError>

StaticupdateWorkspaceConfigs

Type Parameters

Parameters

Returns RequestResult<request_WorkspaceConfigs, unknown, ThrowOnError>

StaticvalidateWorkspaceConfigs

Type Parameters

Parameters

Returns RequestResult<request_WorkspaceConfigs, unknown, ThrowOnError>

Settings

On This Page

`Static`createWorkspace

`Static`createWorkspaceModDeps

`Static`deleteWorkspace

`Static`getWorkspace

`Static`getWorkspaceConfigs

`Static`listWorkspace

`Static`updateWorkspace

`Static`updateWorkspaceConfigs

`Static`validateWorkspaceConfigs