TracOrchestratorApi

class tracdap.api.TracOrchestratorApi

Public API for submitting, querying and managing jobs in the TRAC platform

cancelJob(request)

Request cancellation of a queued or running job.

The job is identified using a tag selector, as for checkJob(). Use checkJob() or followJob() to confirm the job’s status after requesting cancellation.

Parameters:

request (JobStatusRequest)

Return type:

JobStatus

checkJob(request)

Get a snapshot of the current status of a job.

The job is identified using a tag selector, typically the job ID returned by submitJob(). This call returns a single status snapshot; use followJob() for a stream of updates instead.

Parameters:

request (JobStatusRequest)

Return type:

JobStatus

followJob(request)

Follow the status of a job over time.

The job is identified using a tag selector, as for checkJob(). This is a server-streaming equivalent of checkJob(), for clients that want to track a job’s status without polling.

Parameters:

request (JobStatusRequest)

Return type:

JobStatus

submitJob(request)

Submit a job for execution on the TRAC platform.

The response includes the ID of the newly created job, which can be used to check on its progress with checkJob() or followJob().

Parameters:

request (JobRequest)

Return type:

JobStatus

validateJob(request)

Check whether a job request is valid, without submitting it for execution.

Validation covers similar checks to those applied when a job is submitted, so a job that validates successfully can be expected to submit without a validation error.

Parameters:

request (JobRequest)

Return type:

JobStatus