qiskit_serverless.core.ServerlessClient

class ServerlessClient(name=None, host=None, version=None, token=None, verbose=False)

A client for connecting to a specified host.

Example

>>> client = ServerlessClient(
>>>    name="<NAME>",
>>>    host="<HOST>",
>>>    token="<TOKEN>",
>>> )

Initializes the ServerlessClient instance.

Parameters:

• name (Optional[str]) – name of client

• host (Optional[str]) – host of gateway

• version (Optional[str]) – version of gateway

• token (Optional[str]) – authorization token

__init__(name=None, host=None, version=None, token=None, verbose=False)

Initializes the ServerlessClient instance.

Parameters:

• name (Optional[str]) – name of client

• host (Optional[str]) – host of gateway

• version (Optional[str]) – version of gateway

• token (Optional[str]) – authorization token

Methods

__init__([name, host, version, token, verbose])	Initializes the ServerlessClient instance.
file_delete(file, function)	Deletes a file available to the user for the specific Qiskit Function.
file_download(file, function[, target_name, ...])	Download a file available to the user for the specific Qiskit Function.
file_upload(file, function)	Uploads a file in the specific user's Qiskit Function folder.
files(function)	Returns the list of files available for the user in the Qiskit Function folder.
filtered_logs(job_id, **kwargs)	Returns logs of the job.
from_dict(dictionary)	Converts dict to object.
function(**kwargs)	The wrapper
functions(**kwargs)	The wrapper
get(title[, provider])	Returns program based on parameters.
get_job_by_id(job_id)	Returns job by job id.
get_jobs(**kwargs)	Return list of jobs.
job(**kwargs)	The wrapper
jobs(**kwargs)	The wrapper
list(**kwargs)	Returns list of available programs.
logs(**kwargs)	The wrapper
provider_file_delete(file, function)	Deletes a file available to the provider for the specific Qiskit Function.
provider_file_download(file, function[, ...])	Download a file available to the provider for the specific Qiskit Function.
provider_file_upload(file, function)	Uploads a file in the specific provider's Qiskit Function folder.
provider_files(function)	Returns the list of files available for the provider in the Qiskit Function folder.
result(**kwargs)	The wrapper
run(program[, arguments, config, provider])	Run a function and return its job.
status(**kwargs)	The wrapper
stop(**kwargs)	The wrapper
to_dict()	Converts class to dict.
upload(program)	Uploads program.
widget()	Widget for information about provider and jobs.