get_jobs#

geodesic.tesseract.job.get_jobs(search=None, project=None, status='all')[source]#

returns a list of Tesseract Jobs

Parameters:

search (str | None) – a search string used to search within the jobs name, alias or description. This will do simple partial string matching.
project – the name of the project to search jobs. Defaults to the current active project.
status (Literal['completed', 'running', 'deleted', 'all']) – return only jobs that have this status. this can be ‘completed, ‘running’, ‘deleted’, or ‘all’ (default) to return jobs in any state.

Returns:

a JobList of matching Jobs

Return type:

JobList

Example

To list Tesseract jobs related to Hurricane Ida we could run the list_jobs() function like so:

>>> jobs = list_jobs(
...    search="ida",
...    project="ida-demo",
...    status="completed"
... )
>>> jobs[0].alias
    "Ida Road Model"