qiskit_serverless.core.BaseClient¶

class BaseClient(name, host=None, token=None, compute_resource=None, available_compute_resources=None)[source]¶

A client class for specifying custom compute resources.

Example

>>> client = BaseClient(
>>>    name="<NAME>",
>>>    host="<HOST>",
>>>    token="<TOKEN>",
>>>    compute_resource=ComputeResource(
>>>        name="<COMPUTE_RESOURCE_NAME>",
>>>        host="<COMPUTE_RESOURCE_HOST>"
>>>    ),
>>> )

Initialize a BaseClient instance.

Parameters:

name (str) – name of client
host (Optional[str]) – host of client a.k.a managers host
token (Optional[str]) – authentication token for manager
compute_resource (Optional[ComputeResource]) – selected compute_resource from provider
available_compute_resources (Optional[List[ComputeResource]]) – available clusters in provider

__init__(name, host=None, token=None, compute_resource=None, available_compute_resources=None)[source]¶

Initialize a BaseClient instance.

Parameters:

name (str) – name of client
host (Optional[str]) – host of client a.k.a managers host
token (Optional[str]) – authentication token for manager
compute_resource (Optional[ComputeResource]) – selected compute_resource from provider
available_compute_resources (Optional[List[ComputeResource]]) – available clusters in provider

Methods

`__init__`(name[, host, token, ...])	Initialize a BaseClient instance.
`context`(**kwargs)	Allocated context for selected compute_resource for provider.
`create_compute_resource`(resource)	Create compute resource for provider.
`delete_compute_resource`(resource)	Delete compute resource for provider.
`download`(file[, download_location])	Download file.
`file_delete`(file)	Deletes file uploaded or produced by the programs,
`file_download`(file[, target_name, ...])	Download file.
`file_upload`(file)	Upload file.
`files`()	Returns list of available files produced by programs to download.
`from_dict`(dictionary)	Converts dict to object.
`get`(title[, provider])	Returns qiskit function based on title provided.
`get_compute_resources`()	Return compute resources for provider.
`get_job_by_id`(job_id)	Returns job by job id.
`get_jobs`(**kwargs)	Return list of jobs.
`get_programs`(**kwargs)	[Deprecated] Returns list of available programs.
`job_client`()	Return job client for configured compute resource of provider.
`list`(**kwargs)	Returns list of available programs.
`run`(program[, arguments, config])	Execute a program as a async job.
`to_dict`()	Converts class to dict.
`upload`(program)	Uploads program.
`widget`()	Widget for information about provider and jobs.