Struct TaskClient 

pub struct TaskClient { /* private fields */ }

Client for a specific Actor task.

Implementations

impl TaskClient

pub async fn get(&self) -> ApifyClientResult<Option<Task>>

Fetches the task object, or None if it does not exist.

pub async fn update<T: Serialize>( &self, new_fields: &T, ) -> ApifyClientResult<Task>

Updates the task with the given fields.

pub async fn delete(&self) -> ApifyClientResult<()>

Deletes the task.

pub async fn start<T: Serialize>( &self, input: Option<&T>, options: ActorStartOptions, ) -> ApifyClientResult<ActorRun>

Starts the task and returns immediately with the created run.

input overrides the task’s saved input (or None to use the saved input).

pub async fn call<T: Serialize>( &self, input: Option<&T>, options: ActorStartOptions, wait_secs: Option<i64>, ) -> ApifyClientResult<ActorRun>

Starts the task and waits (client-side polling) for it to finish.

wait_secs controls the wait budget:

• None polls indefinitely until the run reaches a terminal state.
• Some(n) bounds the wait to roughly n seconds; if the run has not finished by then, the last fetched (still non-terminal) run is returned rather than an error. Check status / is_terminal() on the result when using Some.

pub async fn get_input(&self) -> ApifyClientResult<Option<Value>>

Fetches the task’s saved input, or None if not set.

pub async fn update_input<T: Serialize>( &self, input: &T, ) -> ApifyClientResult<Value>

Updates the task’s saved input.

pub fn last_run(&self, status: Option<&str>) -> RunClient

Returns a client for the last run of this task, optionally filtered by run status.

status filters by run status (e.g. "SUCCEEDED", "FAILED", "RUNNING"); pass None to leave it unfiltered. This maps to the status query parameter on GET /v2/actor-tasks/{actorTaskId}/runs/last and mirrors the reference client’s lastRun({ status }). To also filter by origin, use TaskClient::last_run_with_options.

pub fn last_run_with_options(&self, options: LastRunOptions) -> RunClient

Returns a client for the last run of this task, applying the given LastRunOptions (e.g. LastRunOptions::status and/or LastRunOptions::origin).

status filters by run status (e.g. "SUCCEEDED", "FAILED", "RUNNING") and is the spec’s documented filter on GET /v2/actor-tasks/{actorTaskId}/runs/last. origin filters by how the run was started; accepted values are the platform’s run origins (e.g. "DEVELOPMENT", "WEB", "API", "SCHEDULER"). origin is not declared by the OpenAPI spec and is sent only for parity with the reference client’s lastRun({ status, origin }). Both are sent as query parameters; leave a field as None to omit it.

pub fn runs(&self) -> RunCollectionClient

Returns a client for this task’s run collection.

pub fn webhooks(&self) -> WebhookCollectionClient

Returns a client for this task’s webhook collection.

Trait Implementations

impl Clone for TaskClient

fn clone(&self) -> TaskClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TaskClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.