TaskCollectionClient

Sub-client for manipulating tasks.

Hierarchy

• ResourceCollectionClient
  • TaskCollectionClient

Index

Methods

• __init__
• create
• list

Methods

__init__

• __init__(args, kwargs): None

• Overrides ResourceCollectionClient.__init__

  Initialize the TaskCollectionClient.

  ---

  Parameters

  • args: Any

  • kwargs: Any

  Returns None

create

• create(*, actor_id, name, build, timeout_secs, memory_mbytes, task_input): 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: Optional[str] = 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: Optional[int] = None

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

  • optionalkeyword-onlymemory_mbytes: Optional[int] = None

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

  • optionalkeyword-onlytask_input: Optional[Dict] = None

    Task input object.

  Returns Dict

  dict: The created task.

list

• list(*, limit, offset, desc): ListPage

• List the available tasks.

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

  ---

  Parameters

  • optionalkeyword-onlylimit: Optional[int] = None

    How many tasks to list

  • optionalkeyword-onlyoffset: Optional[int] = None

    What task to include as first when retrieving the list

  • optionalkeyword-onlydesc: Optional[bool] = None

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

  Returns ListPage

  ListPage: The list of available tasks matching the specified filters.