ScheduleCollectionClient

Sub-client for manipulating schedules.

Index

Methods

• create
• list

Methods

create

• create(*, cron_expression, is_enabled, is_exclusive, name, actions, description, timezone, title): dict

• Create a new schedule.

  https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule

  ---

  Parameters

  • keyword-onlycron_expression: str

    The cron expression used by this schedule

  • keyword-onlyis_enabled: bool

    True if the schedule should be enabled

  • keyword-onlyis_exclusive: bool

    When set to true, don't start Actor or Actor task if it's still running from the previous schedule.

  • keyword-onlyname: str | None = None

    The name of the schedule to create.

  • keyword-onlyactions: list[dict] | None = None

    Actors or tasks that should be run on this schedule. See the API documentation for exact structure.

  • keyword-onlydescription: str | None = None

    Description of this schedule

  • keyword-onlytimezone: str | None = None

    Timezone in which your cron expression runs (TZ database name from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) title: str, optional): Title of this schedule

  • keyword-onlytitle: str | None = None

  Returns dict

  The created schedule.

list

• list(*, limit, offset, desc): ListPage[dict]

• List the available schedules.

  https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules

  ---

  Parameters

  • keyword-onlylimit: int | None = None

    How many schedules to retrieve

  • keyword-onlyoffset: int | None = None

    What schedules to include as first when retrieving the list

  • keyword-onlydesc: bool | None = None

    Whether to sort the schedules in descending order based on their modification date

  Returns ListPage[dict]

  The list of available schedules matching the specified filters.