Skip to main content

ScheduleClient

Sub-client for manipulating a single schedule.

Hierarchy

Index

Methods

Properties

Methods

__init__

  • __init__(*, base_url, root_client, http_client, resource_id, resource_path, params): None

  • Initialize a new instance.

    Parameters

    • keyword-onlybase_url: str

      Base URL of the API server.

    • keyword-onlyroot_client: ApifyClient

      The ApifyClient instance under which this resource client exists.

    • keyword-onlyhttp_client: HTTPClient

      The HTTPClient instance to be used in this client.

    • optionalkeyword-onlyresource_id: str | None = None

      ID of the manipulated resource, in case of a single-resource client.

    • keyword-onlyresource_path: str

      Path to the resource's endpoint on the API server.

    • optionalkeyword-onlyparams: dict | None = None

      Parameters to include in all requests from this client.

    Returns None

delete

  • delete(): None

get

  • get(): dict | None

get_log

  • get_log(): list | None

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

    • optionalkeyword-onlycron_expression: str | None = None

      The cron expression used by this schedule.

    • optionalkeyword-onlyis_enabled: bool | None = None

      True if the schedule should be enabled.

    • optionalkeyword-onlyis_exclusive: bool | None = None

      When set to true, don't start Actor or Actor task if it's still running from the previous schedule.

    • optionalkeyword-onlyname: str | None = None

      The name of the schedule to create.

    • optionalkeyword-onlyactions: list[dict] | None = None

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

    • optionalkeyword-onlydescription: str | None = None

      Description of this schedule.

    • optionalkeyword-onlytimezone: str | None = None

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

    • optionalkeyword-onlytitle: str | None = None

      A human-friendly equivalent of the name.

    Returns dict

Properties

http_client

http_client: HTTPClient | HTTPClientAsync

params

params: dict

resource_id

resource_id: str | None

root_client

root_client: ApifyClient | ApifyClientAsync

url

url: str
Page Options