TaskClientAsync

Async sub-client for manipulating a single task.

Hierarchy

• ResourceClientAsync
  • TaskClientAsync

Index

Methods

• __init__
• call
• delete
• get
• get_input
• last_run
• runs
• start
• update
• update_input
• webhooks

Properties

• http_client
• params
• resource_id
• root_client
• url

Methods

__init__

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

• Overrides ResourceClientAsync.__init__

  Initialize a new instance.

  ---

  Parameters

  • keyword-onlybase_url: str

    Base URL of the API server.

  • keyword-onlyroot_client: ApifyClientAsync

    The ApifyClientAsync instance under which this resource client exists.

  • keyword-onlyhttp_client: HTTPClientAsync

    The HTTPClientAsync 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

call

• async call(*, task_input, build, max_items, memory_mbytes, timeout_secs, restart_on_error, webhooks, wait_secs): dict | None

• Start a task and wait for it to finish before returning the Run object.

  It waits indefinitely, unless the wait_secs argument is provided.

  https://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task

  ---

  Parameters

  • optionalkeyword-onlytask_input: dict | None = None

    Task input dictionary.

  • optionalkeyword-onlybuild: str | None = None

    Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically latest).

  • optionalkeyword-onlymax_items: int | None = None

    Maximum number of results that will be returned by this run. If the Actor is charged per result, you will not be charged for more results than the given limit.

  • optionalkeyword-onlymemory_mbytes: int | None = None

    Memory limit for the run, in megabytes. By default, the run uses a memory limit specified in the task settings.

  • optionalkeyword-onlytimeout_secs: int | None = None

    Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings.

  • optionalkeyword-onlyrestart_on_error: bool | None = None

    If true, the Task run process will be restarted whenever it exits with a non-zero status code.

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

    Specifies optional webhooks associated with the Actor run, which can be used to receive a notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for the Actor or task, you do not have to add it again here.

  • optionalkeyword-onlywait_secs: int | None = None

    The maximum number of seconds the server waits for the task run to finish. If not provided, waits indefinitely.

  Returns dict | None

delete

• async delete(): None

• Delete the task.

  https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task

  ---

  Returns None

get

• async get(): dict | None

• Retrieve the task.

  https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task

  ---

  Returns dict | None

get_input

• async get_input(): dict | None

• Retrieve the default input for this task.

  https://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input

  ---

  Returns dict | None

last_run

• last_run(*, status, origin): RunClientAsync

• Retrieve the client for the last run of this task.

  Last run is retrieved based on the start time of the runs.

  ---

  Parameters

  • optionalkeyword-onlystatus: ActorJobStatus | None = None

    Consider only runs with this status.

  • optionalkeyword-onlyorigin: MetaOrigin | None = None

    Consider only runs started with this origin.

  Returns RunClientAsync

runs

• runs(): RunCollectionClientAsync

• Retrieve a client for the runs of this task.

  ---

  Returns RunCollectionClientAsync

start

• async start(*, task_input, build, max_items, memory_mbytes, timeout_secs, restart_on_error, wait_for_finish, webhooks): dict

• Start the task and immediately return the Run object.

  https://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task

  ---

  Parameters

  • optionalkeyword-onlytask_input: dict | None = None

    Task input dictionary.

  • optionalkeyword-onlybuild: str | None = None

    Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically latest).

  • optionalkeyword-onlymax_items: int | None = None

    Maximum number of results that will be returned by this run. If the Actor is charged per result, you will not be charged for more results than the given limit.

  • optionalkeyword-onlymemory_mbytes: int | None = None

    Memory limit for the run, in megabytes. By default, the run uses a memory limit specified in the task settings.

  • optionalkeyword-onlytimeout_secs: int | None = None

    Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings.

  • optionalkeyword-onlyrestart_on_error: bool | None = None

    If true, the Task run process will be restarted whenever it exits with a non-zero status code.

  • optionalkeyword-onlywait_for_finish: int | None = None

    The maximum number of seconds the server waits for the run to finish. By default, it is 0, the maximum value is 60.

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

    Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with the Actor run which can be used to receive a notification, e.g. when the Actor finished or failed. If you already have a webhook set up for the Actor or task, you do not have to add it again here. Each webhook is represented by a dictionary containing these items:

    • event_types: List of `WebhookEventType` values which trigger the webhook.
    • request_url: URL to which to send the webhook HTTP request.
    • payload_template: Optional template for the request payload.

  Returns dict

update

• async update(*, name, task_input, build, max_items, memory_mbytes, timeout_secs, restart_on_error, title, actor_standby_desired_requests_per_actor_run, actor_standby_max_requests_per_actor_run, actor_standby_idle_timeout_secs, actor_standby_build, actor_standby_memory_mbytes): dict

• Update the task with specified fields.

  https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task

  ---

  Parameters

  • optionalkeyword-onlyname: str | None = None

    Name of the task.

  • optionalkeyword-onlytask_input: dict | None = None

    Task input dictionary.

  • optionalkeyword-onlybuild: str | None = None

    Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically latest).

  • optionalkeyword-onlymax_items: int | None = None

    Maximum number of results that will be returned by this run. If the Actor is charged per result, you will not be charged for more results than the given limit.

  • optionalkeyword-onlymemory_mbytes: int | None = None

    Memory limit for the run, in megabytes. By default, the run uses a memory limit specified in the task settings.

  • optionalkeyword-onlytimeout_secs: int | None = None

    Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings.

  • optionalkeyword-onlyrestart_on_error: bool | None = None

    If true, the Task run process will be restarted whenever it exits with a non-zero status code.

  • optionalkeyword-onlytitle: str | None = None

    A human-friendly equivalent of the name.

  • optionalkeyword-onlyactor_standby_desired_requests_per_actor_run: int | None = None

    The desired number of concurrent HTTP requests for a single Actor Standby run.

  • optionalkeyword-onlyactor_standby_max_requests_per_actor_run: int | None = None

    The maximum number of concurrent HTTP requests for a single Actor Standby run.

  • optionalkeyword-onlyactor_standby_idle_timeout_secs: int | None = None

    If the Actor run does not receive any requests for this time, it will be shut down.

  • optionalkeyword-onlyactor_standby_build: str | None = None

    The build tag or number to run when the Actor is in Standby mode.

  • optionalkeyword-onlyactor_standby_memory_mbytes: int | None = None

    The memory in megabytes to use when the Actor is in Standby mode.

  Returns dict

update_input

• async update_input(*, task_input): dict

• Update the default input for this task.

  https://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input

  ---

  Parameters

  • keyword-onlytask_input: dict

  Returns dict

webhooks

• webhooks(): WebhookCollectionClientAsync

• Retrieve a client for webhooks associated with this task.

  ---

  Returns WebhookCollectionClientAsync

Properties

http_client

http_client: HTTPClient | HTTPClientAsync

Inherited from BaseClientAsync.http_client

Overrides _BaseBaseClient.http_client

params

params: dict

Inherited from _BaseBaseClient.params

resource_id

resource_id: str | None

Inherited from _BaseBaseClient.resource_id

root_client

root_client: ApifyClient | ApifyClientAsync

Inherited from BaseClientAsync.root_client

Overrides _BaseBaseClient.root_client

url

url: str

Inherited from _BaseBaseClient.url