# 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

* [ResourceClient](https://docs.apify.com/api/client/python/reference/class/ResourceClient.md)
  * *ScheduleClient*

## Index[](#Index)

### Methods

* [\_\_init\_\_](https://docs.apify.com/api/client/python/reference/class/ScheduleClient.md#__init__)
* [delete](https://docs.apify.com/api/client/python/reference/class/ScheduleClient.md#delete)
* [get](https://docs.apify.com/api/client/python/reference/class/ScheduleClient.md#get)
* [get_log](https://docs.apify.com/api/client/python/reference/class/ScheduleClient.md#get_log)
* [update](https://docs.apify.com/api/client/python/reference/class/ScheduleClient.md#update)

### Properties

* [resource_id](https://docs.apify.com/api/client/python/reference/class/ScheduleClient.md#resource_id)

## Methods<!-- -->[](#Methods)

### [](#__init__)\_\_init\_\_

* **\_\_init\_\_**(\*, base_url, public_base_url, http_client, resource_path, client_registry, resource_id, params, api_base_url): None

- Overrides [ResourceClient.\_\_init\_\_](https://docs.apify.com/api/client/python/reference/class/ResourceClient.md#__init__)

  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](https://docs.apify.com/api/client/python/reference/class/HttpClient.md)

    HTTP client for making requests.

  * ##### keyword-onlyresource_path: str

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

  * ##### keyword-onlyclient_registry: [ClientRegistry](https://docs.apify.com/api/client/python/reference/class/ClientRegistry.md)

    Bundle of client classes for dependency injection.

  * ##### optionalkeyword-onlyresource_id: str | None = <!-- -->None

    Optional resource ID for single-resource clients.

  * ##### optionalkeyword-onlyparams: [QueryParams](https://docs.apify.com/api/client/python/reference.md#QueryParams) | None = <!-- -->None

    Optional default parameters for all requests.

  * ##### optionalkeyword-onlyapi_base_url: str | None = <!-- -->None

    Base URL of the API itself, for clients of top-level resources. Defaults to `base_url`.

  #### Returns None

### [](#delete)delete

* **delete**(\*, timeout): None

- Delete the schedule.

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

  ***

  #### Parameters

  * ##### optionalkeyword-onlytimeout: [Timeout](https://docs.apify.com/api/client/python/reference.md#Timeout) = <!-- -->'short'

    Timeout for the API HTTP request.

  #### Returns None

### [](#get)get

* **get**(\*, timeout): [Schedule](https://docs.apify.com/api/client/python/reference/class/Schedule.md) | None

- Return information about the schedule.

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

  ***

  #### Parameters

  * ##### optionalkeyword-onlytimeout: [Timeout](https://docs.apify.com/api/client/python/reference.md#Timeout) = <!-- -->'short'

    Timeout for the API HTTP request.

  #### Returns [Schedule](https://docs.apify.com/api/client/python/reference/class/Schedule.md) | None

  The retrieved schedule.

### [](#get_log)get_log

* **get_log**(\*, timeout): [list](https://docs.apify.com/api/client/python/reference/class/ActorCollectionClient.md#list)\[[ScheduleLogEntry](https://docs.apify.com/api/client/python/reference/class/ScheduleLogEntry.md)]

- Return log for the given schedule.

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

  ***

  #### Parameters

  * ##### optionalkeyword-onlytimeout: [Timeout](https://docs.apify.com/api/client/python/reference.md#Timeout) = <!-- -->'medium'

    Timeout for the API HTTP request.

  #### Returns [list](https://docs.apify.com/api/client/python/reference/class/ActorCollectionClient.md#list)\[[ScheduleLogEntry](https://docs.apify.com/api/client/python/reference/class/ScheduleLogEntry.md)]

  Retrieved log of the given schedule.

### [](#update)update

* **update**(\*, cron_expression, is_enabled, is_exclusive, name, actions, description, timezone, title, notifications_email, timeout): [Schedule](https://docs.apify.com/api/client/python/reference/class/Schedule.md)

- 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](https://docs.apify.com/api/client/python/reference/class/ActorCollectionClient.md#list)\[dict\[str, Any]] | 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.

  * ##### optionalkeyword-onlynotifications_email: bool | None = <!-- -->None

    Whether to send email notifications about the schedule's runs.

  * ##### optionalkeyword-onlytimeout: [Timeout](https://docs.apify.com/api/client/python/reference.md#Timeout) = <!-- -->'short'

    Timeout for the API HTTP request.

  #### Returns [Schedule](https://docs.apify.com/api/client/python/reference/class/Schedule.md)

  The updated schedule.

## Properties<!-- -->[](#Properties)

### [](#resource_id)resource_id

resource_id: str | None

Inherited from [ResourceClientBase.resource_id](https://docs.apify.com/api/client/python/reference/class/ResourceClientBase.md#resource_id)

Get the resource ID.
