Skip to main content
Version: 1.12

ScheduleClient

Sub-client for managing a specific schedule.

Provides methods to manage a specific schedule, e.g. get, update, or delete it. Obtain an instance via an appropriate method on the ApifyClient class.

Hierarchy

Index

Methods

__init__

  • __init__(*, base_url, public_base_url, http_client, resource_path, client_registry, resource_id, params): None
  • Initialize the resource client.


    Parameters

    • keyword-onlybase_url: str

      API base URL.

    • keyword-onlypublic_base_url: str

      Public CDN base URL.

    • keyword-onlyhttp_client: HttpClient

      HTTP client for making requests.

    • keyword-onlyresource_path: str

      Resource endpoint path (e.g., 'actors', 'datasets').

    • keyword-onlyclient_registry: ClientRegistry

      Bundle of client classes for dependency injection.

    • optionalkeyword-onlyresource_id: str | None = None

      Optional resource ID for single-resource clients.

    • optionalkeyword-onlyparams: dict | None = None

      Optional default parameters for all requests.

    Returns None

delete

  • delete(*, timeout): None

get

get_log

update

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

Properties

resource_id

resource_id: str | None

Get the resource ID.