ScheduleClient

Sub-client for manipulating a single schedule.

Hierarchy

• ResourceClient
  • ScheduleClient

Index

Methods

• __init__
• delete
• get
• get_log
• update

Methods

__init__

• __init__(args, kwargs): None

• Overrides ResourceClient.__init__

  Initialize the ScheduleClient.

  ---

  Parameters

  • args: Any

  • kwargs: Any

  Returns None

delete

• delete(): None

• Delete the schedule.

  https://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule

  ---

  Returns None

get

• get(): Optional[Dict]

• Return information about the schedule.

  https://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule

  ---

  Returns Optional[Dict]

  dict, optional: The retrieved schedule

get_log

• get_log(): Optional[List]

• Return log for the given schedule.

  https://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log

  ---

  Returns Optional[List]

  list, optional: Retrieved log of the given schedule

update

• update(*, cron_expression, is_enabled, is_exclusive, name, actions, description, timezone): Dict

• Update the schedule with specified fields.

  https://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule

  ---

  Parameters

  • optionalkeyword-onlycron_expression: Optional[str] = None

    The cron expression used by this schedule

  • optionalkeyword-onlyis_enabled: Optional[bool] = None

    True if the schedule should be enabled

  • optionalkeyword-onlyis_exclusive: Optional[bool] = None

    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: Optional[List[Dict]] = None

    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 updated schedule