Constructors
constructor
new IBMCloudClient( __namedParameters: { apiKey?: string; crn?: string; token?: string },): IBMCloudClient Parameters
- __namedParameters: { apiKey?: string; crn?: string; token?: string }
Methods
cancelJob
cancelJob(jobId: string, parentJobId?: string): Promise<null | APIErrorResponse> Parameters
- jobId: string
OptionalparentJobId: string
getBackendErrors
getBackendErrors(backendName: string): Promise<DeviceErrors>
getBackendProperties
getBackendProperties( backendName: string, updatedBefore?: string,): Promise<DeviceProperties> Parameters
- backendName: string
OptionalupdatedBefore: string
getBackends
getBackends(): Promise<AllDevicesResponse> Returns Promise<AllDevicesResponse>
getBackendStatus
getBackendStatus(backendName: string): Promise<DeviceStatus>
getJob
Parameters
- jobId: string
OptionalexcludeParams: boolean
getJobs
Parameters
Optionalparams: GetJobParams
getJobTranspiledCircuits
getJobTranspiledCircuits( jobId: string,): Promise<APIErrorResponse | JobTranspiledCircuitResponse>