Skip to main content

ScheduleCollectionClient

apify_client.clients.ScheduleCollectionClient

Sub-client for manipulating schedules.

Index

Methods

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

    • cron_expression: strkeyword-only

      The cron expression used by this schedule

    • is_enabled: boolkeyword-only

      True if the schedule should be enabled

    • is_exclusive: boolkeyword-only

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

    • name: str | None = Nonekeyword-only

      The name of the schedule to create.

    • actions: list[dict] | None = Nonekeyword-only

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

    • description: str | None = Nonekeyword-only

      Description of this schedule

    • timezone: str | None = Nonekeyword-only

      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

    • title: str | None = Nonekeyword-only

    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

    • limit: int | None = Nonekeyword-only

      How many schedules to retrieve

    • offset: int | None = Nonekeyword-only

      What schedules to include as first when retrieving the list

    • desc: bool | None = Nonekeyword-only

      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.