ScheduleClient

apify_client.clients.ScheduleClient

Sub-client for manipulating a single schedule.

Index

Methods

• delete
• get
• get_log
• update

Methods

delete

• delete(): None

• Delete the schedule.

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

  ---

  Returns None

get

• get(): dict | None

• Return information about the schedule.

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

  ---

  Returns dict | None

  The retrieved schedule

get_log

• get_log(): list | None

• Return log for the given schedule.

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

  ---

  Returns list | None

  Retrieved log of the given schedule

update

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

• Update the schedule with specified fields.

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

  ---

  Parameters

  • cron_expression: str | None = Nonekeyword-only

    The cron expression used by this schedule

  • is_enabled: bool | None = Nonekeyword-only

    True if the schedule should be enabled

  • is_exclusive: bool | None = Nonekeyword-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 | None = Nonekeyword-only

    A human-friendly equivalent of the name

  Returns dict

  The updated schedule