Struct TaskClient 

pub struct TaskClient<'a> { /* private fields */ }

Operations on Tasks.

A Task is a saved configuration for an Actor: it stores the Actor ID, input JSON, and run options. Once created, a Task can be invoked repeatedly without re-sending the full input.

Implementations

impl<'a> TaskClient<'a>

pub async fn list( &self, params: Option<ListParams>, ) -> Result<ListData<TaskShort>, ApifyError>

List Tasks with optional pagination.

pub async fn create<T: Serialize>( &self, request: CreateTaskRequest<T>, ) -> Result<Task, ApifyError>

Create a new Task.

Example

let input = serde_json::json!({ "usernames": ["apify"] });
let task = client.tasks().create(CreateTaskRequest {
    act_id: "apify~instagram-profile-scraper".to_string(),
    name: Some("my-instagram-task".to_string()),
    options: None,
    input: Some(input),
    title: None,
}).await?;

pub async fn get(&self, task_id: &str) -> Result<Task, ApifyError>

Fetch a Task by ID or qualified name (username~task-name).

pub async fn update<T: Serialize>( &self, task_id: &str, request: UpdateTaskRequest<T>, ) -> Result<Task, ApifyError>

Update a Task. Omitted fields leave the existing value unchanged.

pub async fn delete(&self, task_id: &str) -> Result<(), ApifyError>

Delete a Task permanently.

pub async fn run( &self, task_id: &str, params: Option<RunParams>, ) -> Result<Run, ApifyError>

Start a Task run asynchronously.

Uses the Task’s stored input. Returns a Run immediately while the container is queued / started.

pub async fn run_sync( &self, task_id: &str, params: Option<RunParams>, ) -> Result<Run, ApifyError>

Start a Task run synchronously (blocks up to 300 s).

The HTTP response returns the finished Run if it completes in time, otherwise a timeout error.

pub async fn run_sync_get_dataset_items<T: DeserializeOwned>( &self, task_id: &str, params: Option<RunParams>, ) -> Result<Vec<T>, ApifyError>

Start a Task run synchronously and return the default Dataset items directly.

This is the shortest path from “invoke Task” to “get typed results”. The request times out after 300 s if the run does not finish.

pub async fn get_last_run(&self, task_id: &str) -> Result<Run, ApifyError>

Retrieve the most recent Run of a Task.