Skip to main content

ScheduleClientAsync

apify_client.clients.ScheduleClientAsync

Async sub-client for manipulating a single schedule.

Index

Methods

delete

  • async delete(): None

get

  • async get(): dict | None

get_log

  • async get_log(): list | None

update

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

  • 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