ScheduleCollectionClient
apify_client.clients.ScheduleCollectionClient
Index
Methods
create
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: Optional[str] = Noneoptionalkeyword-only
The name of the schedule to create.
actions: Optional[List[Dict]] = Noneoptionalkeyword-only
Actors or tasks that should be run on this schedule. See the API documentation for exact structure.
description: Optional[str] = Noneoptionalkeyword-only
Description of this schedule
timezone: Optional[str] = Noneoptionalkeyword-only
Timezone in which your cron expression runs (TZ database name from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
title: Optional[str] = Noneoptionalkeyword-only
Returns Dict
The created schedule.
list
List the available schedules.
https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules
Parameters
limit: Optional[int] = Noneoptionalkeyword-only
How many schedules to retrieve
offset: Optional[int] = Noneoptionalkeyword-only
What schedules to include as first when retrieving the list
desc: Optional[bool] = Noneoptionalkeyword-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.
Sub-client for manipulating schedules.