kavita_client.api.server.get_api_server_jobs

Module Contents

Functions

asyncio	Returns a list of reoccurring jobs. Scheduled ad-hoc jobs will not be returned.
asyncio_detailed	Returns a list of reoccurring jobs. Scheduled ad-hoc jobs will not be returned.
sync	Returns a list of reoccurring jobs. Scheduled ad-hoc jobs will not be returned.
sync_detailed	Returns a list of reoccurring jobs. Scheduled ad-hoc jobs will not be returned.

API

async kavita_client.api.server.get_api_server_jobs.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → list[kavita_client.models.job_dto.JobDto] | None

Returns a list of reoccurring jobs. Scheduled ad-hoc jobs will not be returned.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

list[JobDto]

async kavita_client.api.server.get_api_server_jobs.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[list[kavita_client.models.job_dto.JobDto]]

Returns a list of reoccurring jobs. Scheduled ad-hoc jobs will not be returned.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[list[JobDto]]

kavita_client.api.server.get_api_server_jobs.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → list[kavita_client.models.job_dto.JobDto] | None

Returns a list of reoccurring jobs. Scheduled ad-hoc jobs will not be returned.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

list[JobDto]

kavita_client.api.server.get_api_server_jobs.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[list[kavita_client.models.job_dto.JobDto]]

Returns a list of reoccurring jobs. Scheduled ad-hoc jobs will not be returned.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[list[JobDto]]