Class ComputeManagerClientV1

Base qBraid client for interacting with qBraid Cloud Services (V1 API). This client requires a QbraidSessionV1 to be provided.

Hierarchy (View Summary)

QbraidClientV1
- ComputeManagerClientV1

Index

Constructors

Properties

Methods

getProfilePrice getProfiles getServerStatus getUserLabToken startServer stopServer

Constructors

constructor

new ComputeManagerClientV1(session: QbraidSessionV1): ComputeManagerClientV1
Parameters
- session: QbraidSessionV1
Returns ComputeManagerClientV1
Overrides QbraidClientV1.constructor
- Defined in compute/src/client.ts:89

Properties

`Protected`session

session: QbraidSessionV1

The QbraidSessionV1 instance used by this client.

Methods

getProfilePrice

getProfilePrice(profileSlug: string): Promise<ProfileCost>
Get the price of a compute profile.
Parameters
- profileSlug: string
  The slug of the profile
Returns Promise<ProfileCost>
Profile cost information

Throws
Error if the API returns an error response
- Defined in compute/src/client.ts:220

getProfiles

getProfiles(params?: ProfileQueryParamsV1): Promise<ComputeProfileV1[]>
Get compute profiles from the V1 API.
Parameters
- Optionalparams: ProfileQueryParamsV1
  Optional query parameters to filter profiles
Returns Promise<ComputeProfileV1[]>
Array of ComputeProfileV1 objects

Throws
Error if the API returns an error response
- Defined in compute/src/client.ts:99

getServerStatus

getServerStatus(): Promise<ServerStatusResponseV1>
Get the status of the current user's compute server.

Returns Promise<ServerStatusResponseV1>
Server status response

Throws
Error if the API returns an error response
- Defined in compute/src/client.ts:170

getUserLabToken

getUserLabToken(): Promise<string>
Get a session token for the current user's compute server.

Returns Promise<string>
The session token string

Throws
Error if the API returns an error response
- Defined in compute/src/client.ts:201

startServer

startServer(profileSlug: string): Promise<ServerStartResponseV1>
Start a compute server with the specified profile.
Parameters
- profileSlug: string
  The slug of the profile to use
Returns Promise<ServerStartResponseV1>
Server start response

Throws
Error if the API returns an error response
- Defined in compute/src/client.ts:119

stopServer

stopServer(): Promise<ServerStopResponseV1>
Stop the current user's compute server.

Returns Promise<ServerStopResponseV1>
Server stop response

Throws
Error if the API returns an error response
- Defined in compute/src/client.ts:145