JobQueueNamespace

pymoonraker.api.JobQueueNamespace

Print job queue management.

Auto-generated from schema/moonraker_api.yaml.

Source code in src/pymoonraker/api/_generated.py

class JobQueueNamespace:
    """Print job queue management.

    Auto-generated from schema/moonraker_api.yaml.
    """

    def __init__(self, client: MoonrakerClient) -> None:
        self._client = client

    async def status(self) -> JobQueueStatus:
        """Get job queue status and queued jobs."""
        raw = await self._client.call("server.job_queue.status")
        return JobQueueStatus.model_validate(raw)

    async def enqueue(self, filenames: builtins.list[str]) -> JobQueueStatus:
        """Add one or more jobs to the queue.

        Args:
            filenames: List of filenames to enqueue

        """
        params: dict[str, Any] = {}
        params["filenames"] = filenames
        raw = await self._client.call("server.job_queue.post_job", params)
        return JobQueueStatus.model_validate(raw)

    async def delete(self, job_ids: builtins.list[str]) -> JobQueueStatus:
        """Remove jobs from the queue.

        Args:
            job_ids: List of job IDs to remove

        """
        params: dict[str, Any] = {}
        params["job_ids"] = job_ids
        raw = await self._client.call("server.job_queue.delete_job", params)
        return JobQueueStatus.model_validate(raw)

    async def pause(self) -> JobQueueStatus:
        """Pause the job queue."""
        raw = await self._client.call("server.job_queue.pause")
        return JobQueueStatus.model_validate(raw)

    async def start(self) -> JobQueueStatus:
        """Start or resume the job queue."""
        raw = await self._client.call("server.job_queue.start")
        return JobQueueStatus.model_validate(raw)

delete async

delete(job_ids: list[str]) -> JobQueueStatus

Remove jobs from the queue.

Parameters:

Name	Type	Description	Default
job_ids	list[str]	List of job IDs to remove	required

Source code in src/pymoonraker/api/_generated.py

async def delete(self, job_ids: builtins.list[str]) -> JobQueueStatus:
    """Remove jobs from the queue.

    Args:
        job_ids: List of job IDs to remove

    """
    params: dict[str, Any] = {}
    params["job_ids"] = job_ids
    raw = await self._client.call("server.job_queue.delete_job", params)
    return JobQueueStatus.model_validate(raw)

enqueue async

enqueue(filenames: list[str]) -> JobQueueStatus

Add one or more jobs to the queue.

Parameters:

Name	Type	Description	Default
filenames	list[str]	List of filenames to enqueue	required

Source code in src/pymoonraker/api/_generated.py

async def enqueue(self, filenames: builtins.list[str]) -> JobQueueStatus:
    """Add one or more jobs to the queue.

    Args:
        filenames: List of filenames to enqueue

    """
    params: dict[str, Any] = {}
    params["filenames"] = filenames
    raw = await self._client.call("server.job_queue.post_job", params)
    return JobQueueStatus.model_validate(raw)

pause async

pause() -> JobQueueStatus

Pause the job queue.

Source code in src/pymoonraker/api/_generated.py

async def pause(self) -> JobQueueStatus:
    """Pause the job queue."""
    raw = await self._client.call("server.job_queue.pause")
    return JobQueueStatus.model_validate(raw)

start async

start() -> JobQueueStatus

Start or resume the job queue.

Source code in src/pymoonraker/api/_generated.py

async def start(self) -> JobQueueStatus:
    """Start or resume the job queue."""
    raw = await self._client.call("server.job_queue.start")
    return JobQueueStatus.model_validate(raw)

status async

status() -> JobQueueStatus

Get job queue status and queued jobs.

Source code in src/pymoonraker/api/_generated.py

async def status(self) -> JobQueueStatus:
    """Get job queue status and queued jobs."""
    raw = await self._client.call("server.job_queue.status")
    return JobQueueStatus.model_validate(raw)