# {py:mod}`ovo.core.scheduler.base_scheduler`

```{py:module} ovo.core.scheduler.base_scheduler
```

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`SchedulerTypes <ovo.core.scheduler.base_scheduler.SchedulerTypes>`
  - ```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.SchedulerTypes
    :summary:
    ```
* - {py:obj}`Scheduler <ovo.core.scheduler.base_scheduler.Scheduler>`
  -
````

### API

`````{py:class} SchedulerTypes
:canonical: ovo.core.scheduler.base_scheduler.SchedulerTypes

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.SchedulerTypes
```

````{py:attribute} REGISTERED_CLASSES
:canonical: ovo.core.scheduler.base_scheduler.SchedulerTypes.REGISTERED_CLASSES
:value: >
   None

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.SchedulerTypes.REGISTERED_CLASSES
```

````

````{py:method} register(name=None)
:canonical: ovo.core.scheduler.base_scheduler.SchedulerTypes.register
:classmethod:

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.SchedulerTypes.register
```

````

`````

```{py:exception} JobNotFound()
:canonical: ovo.core.scheduler.base_scheduler.JobNotFound

Bases: {py:obj}`Exception`

```

`````{py:class} Scheduler(name: str, workdir: str, reference_files_dir: str, allow_submit: bool = True, submission_args: dict = None)
:canonical: ovo.core.scheduler.base_scheduler.Scheduler

Bases: {py:obj}`abc.ABC`

````{py:method} submit(pipeline_name: str, params: dict = None, submission_args: dict = None) -> str
:canonical: ovo.core.scheduler.base_scheduler.Scheduler.submit
:abstractmethod:

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.Scheduler.submit
```

````

````{py:method} get_status_label(job_id: str) -> str
:canonical: ovo.core.scheduler.base_scheduler.Scheduler.get_status_label
:abstractmethod:

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.Scheduler.get_status_label
```

````

````{py:method} get_result(job_id: str) -> bool | None
:canonical: ovo.core.scheduler.base_scheduler.Scheduler.get_result
:abstractmethod:

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.Scheduler.get_result
```

````

````{py:method} get_log(job_id: str) -> str | None
:canonical: ovo.core.scheduler.base_scheduler.Scheduler.get_log
:abstractmethod:

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.Scheduler.get_log
```

````

````{py:method} cancel(job_id)
:canonical: ovo.core.scheduler.base_scheduler.Scheduler.cancel
:abstractmethod:

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.Scheduler.cancel
```

````

````{py:method} get_output_dir(job_id: str)
:canonical: ovo.core.scheduler.base_scheduler.Scheduler.get_output_dir
:abstractmethod:

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.Scheduler.get_output_dir
```

````

````{py:method} get_job_start_time(job_id: str) -> datetime.datetime | None
:canonical: ovo.core.scheduler.base_scheduler.Scheduler.get_job_start_time
:abstractmethod:

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.Scheduler.get_job_start_time
```

````

````{py:method} get_job_stop_time(job_id: str) -> datetime.datetime | None
:canonical: ovo.core.scheduler.base_scheduler.Scheduler.get_job_stop_time
:abstractmethod:

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.Scheduler.get_job_stop_time
```

````

````{py:method} get_startup_time_minutes()
:canonical: ovo.core.scheduler.base_scheduler.Scheduler.get_startup_time_minutes

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.Scheduler.get_startup_time_minutes
```

````

````{py:method} wait(job_id: str, timeout: int = None, interval: int | float = 10) -> bool
:canonical: ovo.core.scheduler.base_scheduler.Scheduler.wait

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.Scheduler.wait
```

````

````{py:method} get_pipeline_names() -> list[str]
:canonical: ovo.core.scheduler.base_scheduler.Scheduler.get_pipeline_names
:abstractmethod:

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.Scheduler.get_pipeline_names
```

````

````{py:method} get_param_schema(pipeline_name: str) -> dict | None
:canonical: ovo.core.scheduler.base_scheduler.Scheduler.get_param_schema

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.Scheduler.get_param_schema
```

````

````{py:method} get_failed_message(job_id)
:canonical: ovo.core.scheduler.base_scheduler.Scheduler.get_failed_message

```{autodoc2-docstring} ovo.core.scheduler.base_scheduler.Scheduler.get_failed_message
```

````

`````