Skip to main content

TaskCollectionClient

Sub-client for manipulating tasks.

Index

Methods

Methods

create

  • create(*, actor_id, name, build, timeout_secs, memory_mbytes, max_items, task_input, 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

  • Create a new task.

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

    Parameters

    • keyword-onlyactor_id: str

      Id of the Actor that should be run.

    • keyword-onlyname: str

      Name of the task.

    • 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-onlytimeout_secs: int | None = None

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

    • 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-onlymax_items: int | None = None

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

    • optionalkeyword-onlytask_input: dict | None = None

      Task input object.

    • 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

list

  • list(*, limit, offset, desc): ListPage[dict]

  • List the available tasks.

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

    Parameters

    • optionalkeyword-onlylimit: int | None = None

      How many tasks to list.

    • optionalkeyword-onlyoffset: int | None = None

      What task to include as first when retrieving the list.

    • optionalkeyword-onlydesc: bool | None = None

      Whether to sort the tasks in descending order based on their creation date.

    Returns ListPage[dict]

Page Options