Class IBMCloudClient

Index

Constructors

Methods

cancelJob deleteJob getBackendConfiguration getBackendErrors getBackendProperties getBackends getBackendStatus getJob getJobLogs getJobMetrics getJobs getJobTranspiledCircuits

Constructors

constructor

new IBMCloudClient(
__namedParameters: { apiKey?: string; crn?: string; token?: string },
): IBMCloudClient
Parameters
- __namedParameters: { apiKey?: string; crn?: string; token?: string }
Returns IBMCloudClient
- Defined in ibm-cloud/src/client.ts:29

Methods

cancelJob

cancelJob(jobId: string, parentJobId?: string): Promise<null | APIErrorResponse>
Parameters
- jobId: string
- OptionalparentJobId: string
Returns Promise<null | APIErrorResponse>
- Defined in ibm-cloud/src/client.ts:206

deleteJob

deleteJob(jobId: string): Promise<null | APIErrorResponse>
Parameters
- jobId: string
Returns Promise<null | APIErrorResponse>
- Defined in ibm-cloud/src/client.ts:200

getBackendConfiguration

getBackendConfiguration(backendName: string): Promise<DeviceConfiguration>
Parameters
- backendName: string
Returns Promise<DeviceConfiguration>
- Defined in ibm-cloud/src/client.ts:125

getBackendErrors

getBackendErrors(backendName: string): Promise<DeviceErrors>
Parameters
- backendName: string
Returns Promise<DeviceErrors>
- Defined in ibm-cloud/src/client.ts:141

getBackendProperties

getBackendProperties(
backendName: string,
updatedBefore?: string,
): Promise<DeviceProperties>
Parameters
- backendName: string
- OptionalupdatedBefore: string
Returns Promise<DeviceProperties>
- Defined in ibm-cloud/src/client.ts:110

getBackends

getBackends(): Promise<AllDevicesResponse>
Returns Promise<AllDevicesResponse>
- Defined in ibm-cloud/src/client.ts:103

getBackendStatus

getBackendStatus(backendName: string): Promise<DeviceStatus>
Parameters
- backendName: string
Returns Promise<DeviceStatus>
- Defined in ibm-cloud/src/client.ts:134

getJob

getJob(jobId: string, excludeParams?: boolean): Promise<Job | APIErrorResponse>
Parameters
- jobId: string
- OptionalexcludeParams: boolean
Returns Promise<Job | APIErrorResponse>
- Defined in ibm-cloud/src/client.ts:190

getJobLogs

getJobLogs(jobId: string): Promise<string | APIErrorResponse>
Parameters
- jobId: string
Returns Promise<string | APIErrorResponse>
- Defined in ibm-cloud/src/client.ts:220

getJobMetrics

getJobMetrics(jobId: string): Promise<JobMetrics | APIErrorResponse>
Parameters
- jobId: string
Returns Promise<JobMetrics | APIErrorResponse>
- Defined in ibm-cloud/src/client.ts:236

getJobs

getJobs(params?: GetJobParams): Promise<JobList | APIErrorResponse>
Parameters
- Optionalparams: GetJobParams
Returns Promise<JobList | APIErrorResponse>
- Defined in ibm-cloud/src/client.ts:184

getJobTranspiledCircuits

getJobTranspiledCircuits(
jobId: string,
): Promise<APIErrorResponse | JobTranspiledCircuitResponse>
Parameters
- jobId: string
Returns Promise<APIErrorResponse | JobTranspiledCircuitResponse>
- Defined in ibm-cloud/src/client.ts:226