et_engine.jobs

Functions

clear_batches()	Deletes all the available batches for the user.
list_batches()	Lists all the available batches for the user

Classes

Batch(batch_id)	Class for interacting with a Batch
Job(batch_id, job_id)	Class for interacting with a Job

et_engine.jobs.list_batches()

Lists all the available batches for the user

Return type:

A list of Batch objects

et_engine.jobs.clear_batches()

Deletes all the available batches for the user.

• NOTE: This will not cancel any jobs, which will still run and incur costs once cleared.

class et_engine.jobs.Batch(batch_id)

Class for interacting with a Batch

id

unique ID of the batch

url

API endpoint for this batch

Type:

string

__init__(batch_id)

Parameters:

batch_id (string) – The batch ID to connect to

list_jobs()

List the jobs in this batch

Return type:

a lit of Job objects

delete()

Delete this batch. * NOTE: This will not cancel any jobs, which will still run and incur costs once deleted.

status(max_retries=5)

Returns the basic information of this batch and summarizes the job status.

Return type:

a dictionary with a summary (see HTTP docs)

wait(sleep_time=60, thresh=None)

class et_engine.jobs.Job(batch_id, job_id)

Class for interacting with a Job

batch

Parent batch for this job

Type:

Batch

id

unique ID of the tool

Type:

string

url

API endpoint for this tool

Type:

string

__init__(batch_id, job_id)

Parameters:

• batch_id (string) – unique ID of the parent batch

• job_id (string) – unique ID of the job to connect to

status()

Describes the status of the job.

Return type:

a dictionary of the job status (see HTTP docs)