Skip to main content

ScheduleCollectionClient

Sub-client for manipulating schedules.

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

create

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

  • Create a new schedule.

    https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule

    Parameters

    • keyword-onlycron_expression: str

      The cron expression used by this schedule.

    • keyword-onlyis_enabled: bool

      True if the schedule should be enabled.

    • keyword-onlyis_exclusive: bool

      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

      Title of this schedule.

    Returns dict

list

  • list(*, limit, offset, desc): ListPage[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