ScheduleCollectionClient

Sub-client for manipulating schedules.

Hierarchy

• ResourceCollectionClient
  • ScheduleCollectionClient

Index

Methods

• __init__
• create
• list

Methods

__init__

• __init__(args, kwargs): None

• Overrides ResourceCollectionClient.__init__

  Initialize the ScheduleCollectionClient with the passed arguments.

  ---

  Parameters

  • args: Any

  • kwargs: Any

  Returns None

create

• create(*, cron_expression, is_enabled, is_exclusive, name, actions, description, timezone): 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.

  • optionalkeyword-onlyname: Optional[str] = None

    The name of the schedule to create.

  • optionalkeyword-onlyactions: List[Dict] = []

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

  • optionalkeyword-onlydescription: Optional[str] = None

    Description of this schedule

  • optionalkeyword-onlytimezone: Optional[str] = None

    Timezone in which your cron expression runs (TZ database name from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

  Returns Dict

  dict: The created schedule.

list

• list(*, limit, offset, desc): ListPage

• List the available schedules.

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

  ---

  Parameters

  • optionalkeyword-onlylimit: Optional[int] = None

    How many schedules to retrieve

  • optionalkeyword-onlyoffset: Optional[int] = None

    What schedules to include as first when retrieving the list

  • optionalkeyword-onlydesc: Optional[bool] = None

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

  Returns ListPage

  ListPage: The list of available schedules matching the specified filters.