alabpy#

Jobs Service#

class JobsServiceApi(connection: ALabApiConnection)#

The Jobs Service, which is distinct from the Job API

async delete_associated_id(
job_id: str,
name: str,
metadata: Dict | Metadata | Tuple | None = None,
) → None#

Remove a named piece of associated data from a job.

Parameters:

  • job_id – The ID of the job from which to remove the data

  • name – The label of the data to remove

  • metadata – gRPC metadata to include on the remote call

async upsert_associated_id(
job_id: str,
name: str,
value: str,
metadata: Dict | Metadata | Tuple | None = None,
) → None#

Add or update a named piece of associated data on a job, typically an ID of a sample related to the job in some way.

Parameters:

  • job_id – The ID of the job on which to put the data

  • name – The label for the data

  • value – The data itself

  • metadata – gRPC metadata to include on the remote call