kavita_client.api.server.get_api_server_is_task_running

Module Contents

Functions

asyncio	Returns true if a task is currently running or has been queued. Can be scoped to a queue, default to the default queue
asyncio_detailed	Returns true if a task is currently running or has been queued. Can be scoped to a queue, default to the default queue
sync	Returns true if a task is currently running or has been queued. Can be scoped to a queue, default to the default queue
sync_detailed	Returns true if a task is currently running or has been queued. Can be scoped to a queue, default to the default queue

API

async kavita_client.api.server.get_api_server_is_task_running.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, method_name: str | kavita_client.types.Unset = UNSET, queue: str | kavita_client.types.Unset = UNSET) → bool | None

Returns true if a task is currently running or has been queued. Can be scoped to a queue, default to the default queue

Args:

method_name (str | Unset): queue (str | Unset):

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:

bool

async kavita_client.api.server.get_api_server_is_task_running.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, method_name: str | kavita_client.types.Unset = UNSET, queue: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[bool]

Returns true if a task is currently running or has been queued. Can be scoped to a queue, default to the default queue

Args:

method_name (str | Unset): queue (str | Unset):

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[bool]

kavita_client.api.server.get_api_server_is_task_running.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, method_name: str | kavita_client.types.Unset = UNSET, queue: str | kavita_client.types.Unset = UNSET) → bool | None

Returns true if a task is currently running or has been queued. Can be scoped to a queue, default to the default queue

Args:

method_name (str | Unset): queue (str | Unset):

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:

bool

kavita_client.api.server.get_api_server_is_task_running.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, method_name: str | kavita_client.types.Unset = UNSET, queue: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[bool]

Returns true if a task is currently running or has been queued. Can be scoped to a queue, default to the default queue

Args:

method_name (str | Unset): queue (str | Unset):

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[bool]