List function schedules

async AsyncCogniteClient.functions.schedules.list(
name: str | None = None,
function_id: int | None = None,
function_external_id: str | None = None,
created_time: dict[str, int] | TimestampRange | None = None,
cron_expression: str | None = None,
limit: int | None = 25,
) FunctionSchedulesList

List all schedules associated with a specific project.

Parameters:
  • name (str | None) – Name of the function schedule.

  • function_id (int | None) – ID of the function the schedules are linked to.

  • function_external_id (str | None) – External ID of the function the schedules are linked to.

  • created_time (dict[str, int] | TimestampRange | None) – Range between two timestamps. Possible keys are min and max, with values given as time stamps in ms.

  • cron_expression (str | None) – Cron expression.

  • limit (int | None) – Maximum number of schedules to list. Pass in -1, float(‘inf’) or None to list all.

Returns:

List of function schedules

Return type:

FunctionSchedulesList

Examples

List function schedules:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> schedules = client.functions.schedules.list()

List schedules directly on a function object to get only schedules associated with this particular function:

>>> func = client.functions.retrieve(id=1)
>>> schedules = func.list_schedules(limit=None)